@homeostate/store-mobx-state-tree 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @homeostate/store-mobx-state-tree
 
+## 0.2.0
+
+### Minor Changes
+
+- 81d1d18: Stop exporting the adapter classes (`JotaiAdapter`, `MobxAdapter`, `MobxStateTreeAdapter`, `ReduxAdapter`, `TanStackStoreAdapter`, `ValtioAdapter`, `ZustandAdapter`); create adapters with the `create*Adapter` factories, which now carry the adapter docs and examples.
+
+### Patch Changes
+
+- 33c7b14: Mark the package side-effect free, so bundlers can drop modules that are not imported.
+- Updated dependencies [a643bbe]
+- Updated dependencies [0bbf653]
+- Updated dependencies [fb76f77]
+  - @homeostate/core@0.2.0
+
 ## 0.1.2
 
 ### Patch Changes

package/dist/adapter.d.ts

@@ -1,12 +1,15 @@
 import { type IStateTreeNode, type IType } from "mobx-state-tree";
-import type { StoreAdapter, Unsubscribe } from "@homeostate/core";
+import type { StoreAdapter } from "@homeostate/core";
 /** A state tree node whose output snapshot is `S` */
 export type SnapshotNode<S> = IStateTreeNode<IType<unknown, S, unknown>>;
 /**
- * MobX-State-Tree adapter that syncs a tree node through its snapshots.
+ * Creates a MobX-State-Tree adapter that syncs a tree node through its snapshots.
  * Snapshots go to the backend once per action, and remote changes are applied
  * with `applySnapshot`, so instances with identifiers are reconciled in place.
  *
+ * @param node - The tree node to sync; usually the root instance
+ * @returns StoreAdapter instance for the node
+ *
  * @example
  * ```typescript
  * import { types } from 'mobx-state-tree';
@@ -24,22 +27,5 @@ export type SnapshotNode<S> = IStateTreeNode<IType<unknown, S, unknown>>;
  * counter.increment();
  * ```
  */
-export declare class MobxStateTreeAdapter<S extends object> implements StoreAdapter<S> {
-    private node;
-    /**
-     * Create a MobX-State-Tree adapter
-     * @param node - The tree node to sync; usually the root instance
-     */
-    constructor(node: SnapshotNode<S>);
-    getState(): S;
-    setState(state: S): void;
-    subscribe(onStoreChange: () => void): Unsubscribe;
-}
-/**
- * Factory function to create a MobX-State-Tree adapter
- *
- * @param node - The tree node to sync; usually the root instance
- * @returns StoreAdapter instance for the node
- */
 export declare function createMobxStateTreeAdapter<S extends object>(node: SnapshotNode<S>): StoreAdapter<S>;
 //# sourceMappingURL=adapter.d.ts.map

package/dist/adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,KAAK,EACX,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAElE,qDAAqD;AACrD,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,cAAc,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AAEzE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,oBAAoB,CAAC,CAAC,SAAS,MAAM,CAAE,YAAW,YAAY,CAAC,CAAC,CAAC;IAC5E,OAAO,CAAC,IAAI,CAAkB;IAE9B;;;OAGG;gBACS,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC;IAIjC,QAAQ,IAAI,CAAC;IAIb,QAAQ,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI;IAIxB,SAAS,CAAC,aAAa,EAAE,MAAM,IAAI,GAAG,WAAW;CAGlD;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,SAAS,MAAM,EACzD,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GACpB,YAAY,CAAC,CAAC,CAAC,CAEjB"}
+{"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,cAAc,EACnB,KAAK,KAAK,EACX,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EAAE,YAAY,EAAe,MAAM,kBAAkB,CAAC;AAElE,qDAAqD;AACrD,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,cAAc,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;AA0BzE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,0BAA0B,CAAC,CAAC,SAAS,MAAM,EACzD,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,GACpB,YAAY,CAAC,CAAC,CAAC,CAEjB"}

package/dist/adapter.js

@@ -1,27 +1,5 @@
 import { applySnapshot, getSnapshot, onSnapshot, } from "mobx-state-tree";
-/**
- * MobX-State-Tree adapter that syncs a tree node through its snapshots.
- * Snapshots go to the backend once per action, and remote changes are applied
- * with `applySnapshot`, so instances with identifiers are reconciled in place.
- *
- * @example
- * ```typescript
- * import { types } from 'mobx-state-tree';
- * import * as Y from 'yjs';
- * import { createYjsBackend } from '@homeostate/crdt-yjs';
- *
- * const Counter = types
- *   .model({ count: 0 })
- *   .actions((self) => ({ increment() { self.count++; } }));
- *
- * const counter = Counter.create();
- * const adapter = createMobxStateTreeAdapter(counter);
- * const engine = createSyncEngine(createYjsBackend(new Y.Doc(), 'shared'), adapter);
- * engine.connect();
- * counter.increment();
- * ```
- */
-export class MobxStateTreeAdapter {
+class MobxStateTreeAdapter {
     /**
      * Create a MobX-State-Tree adapter
      * @param node - The tree node to sync; usually the root instance
@@ -46,10 +24,29 @@ export class MobxStateTreeAdapter {
     }
 }
 /**
- * Factory function to create a MobX-State-Tree adapter
+ * Creates a MobX-State-Tree adapter that syncs a tree node through its snapshots.
+ * Snapshots go to the backend once per action, and remote changes are applied
+ * with `applySnapshot`, so instances with identifiers are reconciled in place.
  *
  * @param node - The tree node to sync; usually the root instance
  * @returns StoreAdapter instance for the node
+ *
+ * @example
+ * ```typescript
+ * import { types } from 'mobx-state-tree';
+ * import * as Y from 'yjs';
+ * import { createYjsBackend } from '@homeostate/crdt-yjs';
+ *
+ * const Counter = types
+ *   .model({ count: 0 })
+ *   .actions((self) => ({ increment() { self.count++; } }));
+ *
+ * const counter = Counter.create();
+ * const adapter = createMobxStateTreeAdapter(counter);
+ * const engine = createSyncEngine(createYjsBackend(new Y.Doc(), 'shared'), adapter);
+ * engine.connect();
+ * counter.increment();
+ * ```
  */
 export function createMobxStateTreeAdapter(node) {
     return new MobxStateTreeAdapter(node);

package/dist/adapter.js.map

@@ -1 +1 @@
-{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,WAAW,EACX,UAAU,GAGX,MAAM,iBAAiB,CAAC;AAMzB;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,oBAAoB;IAG/B;;;OAGG;IACH,YAAY,IAAqB;QANzB;;;;;WAAsB;QAO5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,QAAQ;QACN,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,QAAQ,CAAC,KAAQ;QACf,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,SAAS,CAAC,aAAyB;QACjC,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CACxC,IAAqB;IAErB,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC"}
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../src/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,WAAW,EACX,UAAU,GAGX,MAAM,iBAAiB,CAAC;AAMzB,MAAM,oBAAoB;IAGxB;;;OAGG;IACH,YAAY,IAAqB;QANzB;;;;;WAAsB;QAO5B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,QAAQ;QACN,OAAO,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,QAAQ,CAAC,KAAQ;QACf,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,SAAS,CAAC,aAAyB;QACjC,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,CAAC,aAAa,EAAE,CAAC,CAAC;IACtD,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,UAAU,0BAA0B,CACxC,IAAqB;IAErB,OAAO,IAAI,oBAAoB,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC"}

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export { MobxStateTreeAdapter, createMobxStateTreeAdapter } from "./adapter.js";
+export { createMobxStateTreeAdapter } from "./adapter.js";
 export type { SnapshotNode } from "./adapter.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAChF,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AAC1D,YAAY,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC"}

package/dist/index.js

@@ -1,2 +1,2 @@
-export { MobxStateTreeAdapter, createMobxStateTreeAdapter } from "./adapter.js";
+export { createMobxStateTreeAdapter } from "./adapter.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homeostate/store-mobx-state-tree",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "MobX-State-Tree adapter for @homeostate/core",
   "license": "MIT",
   "type": "module",
@@ -29,6 +29,7 @@
       "default": "./dist/index.js"
     }
   },
+  "sideEffects": false,
   "files": [
     "dist",
     "src",
@@ -41,7 +42,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@homeostate/core": "^0.1.2"
+    "@homeostate/core": "^0.2.0"
   },
   "peerDependencies": {
     "mobx": "^6.0.0 || ^7.0.0",

package/src/adapter.ts

@@ -10,29 +10,7 @@ import type { StoreAdapter, Unsubscribe } from "@homeostate/core";
 /** A state tree node whose output snapshot is `S` */
 export type SnapshotNode<S> = IStateTreeNode<IType<unknown, S, unknown>>;
 
-/**
- * MobX-State-Tree adapter that syncs a tree node through its snapshots.
- * Snapshots go to the backend once per action, and remote changes are applied
- * with `applySnapshot`, so instances with identifiers are reconciled in place.
- *
- * @example
- * ```typescript
- * import { types } from 'mobx-state-tree';
- * import * as Y from 'yjs';
- * import { createYjsBackend } from '@homeostate/crdt-yjs';
- *
- * const Counter = types
- *   .model({ count: 0 })
- *   .actions((self) => ({ increment() { self.count++; } }));
- *
- * const counter = Counter.create();
- * const adapter = createMobxStateTreeAdapter(counter);
- * const engine = createSyncEngine(createYjsBackend(new Y.Doc(), 'shared'), adapter);
- * engine.connect();
- * counter.increment();
- * ```
- */
-export class MobxStateTreeAdapter<S extends object> implements StoreAdapter<S> {
+class MobxStateTreeAdapter<S extends object> implements StoreAdapter<S> {
   private node: SnapshotNode<S>;
 
   /**
@@ -57,10 +35,29 @@ export class MobxStateTreeAdapter<S extends object> implements StoreAdapter<S> {
 }
 
 /**
- * Factory function to create a MobX-State-Tree adapter
+ * Creates a MobX-State-Tree adapter that syncs a tree node through its snapshots.
+ * Snapshots go to the backend once per action, and remote changes are applied
+ * with `applySnapshot`, so instances with identifiers are reconciled in place.
  *
  * @param node - The tree node to sync; usually the root instance
  * @returns StoreAdapter instance for the node
+ *
+ * @example
+ * ```typescript
+ * import { types } from 'mobx-state-tree';
+ * import * as Y from 'yjs';
+ * import { createYjsBackend } from '@homeostate/crdt-yjs';
+ *
+ * const Counter = types
+ *   .model({ count: 0 })
+ *   .actions((self) => ({ increment() { self.count++; } }));
+ *
+ * const counter = Counter.create();
+ * const adapter = createMobxStateTreeAdapter(counter);
+ * const engine = createSyncEngine(createYjsBackend(new Y.Doc(), 'shared'), adapter);
+ * engine.connect();
+ * counter.increment();
+ * ```
  */
 export function createMobxStateTreeAdapter<S extends object>(
   node: SnapshotNode<S>,

package/src/index.ts

@@ -1,2 +1,2 @@
-export { MobxStateTreeAdapter, createMobxStateTreeAdapter } from "./adapter.js";
+export { createMobxStateTreeAdapter } from "./adapter.js";
 export type { SnapshotNode } from "./adapter.js";