@tanstack/store 0.0.1-beta.90 → 0.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/store",
   "author": "Tanner Linsley",
-  "version": "0.0.1-beta.90",
+  "version": "0.1.0",
   "license": "MIT",
   "repository": "tanstack/store",
   "homepage": "https://tanstack.com/store",
@@ -17,19 +17,35 @@
     "type": "github",
     "url": "https://github.com/sponsors/tannerlinsley"
   },
-  "module": "build/esm/index.js",
-  "main": "build/cjs/index.js",
-  "browser": "build/umd/index.production.js",
-  "types": "build/types/index.d.ts",
-  "engines": {
-    "node": ">=12"
+  "type": "module",
+  "types": "build/legacy/index.d.ts",
+  "main": "build/legacy/index.cjs",
+  "module": "build/legacy/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./build/modern/index.d.ts",
+        "default": "./build/modern/index.js"
+      },
+      "require": {
+        "types": "./build/modern/index.d.cts",
+        "default": "./build/modern/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
   },
+  "sideEffects": false,
   "files": [
-    "build/**",
+    "build",
     "src"
   ],
-  "sideEffects": false,
   "scripts": {
-    "build": "rollup --config rollup.config.js"
+    "clean": "rimraf ./build && rimraf ./coverage",
+    "test:eslint": "eslint --ext .ts,.tsx ./src",
+    "test:types": "tsc",
+    "test:lib": "vitest run --coverage",
+    "test:lib:dev": "pnpm run test:lib --watch",
+    "test:build": "publint --strict",
+    "build": "tsup"
   }
 }

package/src/__tests__/index.test.tsx

@@ -0,0 +1,83 @@
+import { describe, test, expect, vi } from 'vitest'
+import { Store } from '../index'
+
+describe('store', () => {
+  test(`should set the initial value`, () => {
+    const store = new Store(0)
+
+    expect(store.state).toEqual(0)
+  })
+
+  test(`basic subscriptions should work`, () => {
+    const store = new Store(0)
+
+    const subscription = vi.fn()
+
+    const unsub = store.subscribe(subscription)
+
+    store.setState(() => 1)
+
+    expect(store.state).toEqual(1)
+    expect(subscription).toHaveBeenCalled()
+
+    unsub()
+
+    store.setState(() => 2)
+
+    expect(store.state).toEqual(2)
+
+    expect(subscription).toHaveBeenCalledTimes(1)
+  })
+
+  test(`setState passes previous state`, () => {
+    const store = new Store(3)
+
+    store.setState((v) => v + 1)
+
+    expect(store.state).toEqual(4)
+  })
+
+  test(`updateFn acts as state transformer`, () => {
+    const store = new Store(1, {
+      updateFn: (v) => (updater) => Number(updater(v)),
+    })
+
+    store.setState((v) => `${v + 1}` as never)
+
+    expect(store.state).toEqual(2)
+
+    store.setState((v) => `${v + 2}` as never)
+
+    expect(store.state).toEqual(4)
+
+    expect(typeof store.state).toEqual('number')
+  })
+
+  test('Batch prevents listeners from being called during repeated setStates', () => {
+    const store = new Store(0)
+
+    const listener = vi.fn()
+
+    store.subscribe(listener)
+
+    store.batch(() => {
+      store.setState(() => 1)
+      store.setState(() => 2)
+      store.setState(() => 3)
+      store.setState(() => 4)
+    })
+
+    expect(store.state).toEqual(4)
+    // Listener is only called once because of batching
+    expect(listener).toHaveBeenCalledTimes(1)
+
+    store.setState(() => 1)
+    store.setState(() => 2)
+    store.setState(() => 3)
+    store.setState(() => 4)
+
+    expect(store.state).toEqual(4)
+    // Listener is called 4 times because of a lack of batching
+    expect(listener).toHaveBeenCalledTimes(5)
+  })
+})

package/src/index.ts

@@ -1,6 +1,8 @@
 export type AnyUpdater = (...args: any[]) => any
 
-export type Listener = () => void
+export type Listener = (opts: { priority: Priority }) => void
+
+export type Priority = 'high' | 'low'
 
 interface StoreOptions<
   TState,
@@ -11,7 +13,8 @@ interface StoreOptions<
     listener: Listener,
     store: Store<TState, TUpdater>,
   ) => () => void
-  onUpdate?: () => void
+  onUpdate?: (opts: { priority: Priority }) => void
+  defaultPriority?: Priority
 }
 
 export class Store<
@@ -23,6 +26,7 @@ export class Store<
   options?: StoreOptions<TState, TUpdater>
   _batching = false
   _flushing = 0
+  _nextPriority: null | Priority = null
 
   constructor(initialState: TState, options?: StoreOptions<TState, TUpdater>) {
     this.state = initialState
@@ -38,14 +42,30 @@ export class Store<
     }
   }
 
-  setState = (updater: TUpdater) => {
+  setState = (
+    updater: TUpdater,
+    opts?: {
+      priority: Priority
+    },
+  ) => {
     const previous = this.state
     this.state = this.options?.updateFn
       ? this.options.updateFn(previous)(updater)
       : (updater as any)(previous)
 
+    const priority = opts?.priority ?? this.options?.defaultPriority ?? 'high'
+    if (this._nextPriority === null) {
+      this._nextPriority = priority
+    } else if (this._nextPriority === 'high') {
+      this._nextPriority = priority
+    } else {
+      this._nextPriority = this.options?.defaultPriority ?? 'high'
+    }
+
     // Always run onUpdate, regardless of batching
-    this.options?.onUpdate?.()
+    this.options?.onUpdate?.({
+      priority: this._nextPriority,
+    })
 
     // Attempt to flush
     this._flush()
@@ -56,7 +76,9 @@ export class Store<
     const flushId = ++this._flushing
     this.listeners.forEach((listener) => {
       if (this._flushing !== flushId) return
-      listener()
+      listener({
+        priority: this._nextPriority ?? 'high',
+      })
     })
   }
 

package/build/cjs/index.js

@@ -1,59 +0,0 @@
-/**
- * store
- *
- * Copyright (c) TanStack
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE.md file in the root directory of this source tree.
- *
- * @license MIT
- */
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-class Store {
-  listeners = new Set();
-  _batching = false;
-  _flushing = 0;
-  constructor(initialState, options) {
-    this.state = initialState;
-    this.options = options;
-  }
-  subscribe = listener => {
-    this.listeners.add(listener);
-    const unsub = this.options?.onSubscribe?.(listener, this);
-    return () => {
-      this.listeners.delete(listener);
-      unsub?.();
-    };
-  };
-  setState = updater => {
-    const previous = this.state;
-    this.state = this.options?.updateFn ? this.options.updateFn(previous)(updater) : updater(previous);
-
-    // Always run onUpdate, regardless of batching
-    this.options?.onUpdate?.();
-
-    // Attempt to flush
-    this._flush();
-  };
-  _flush = () => {
-    if (this._batching) return;
-    const flushId = ++this._flushing;
-    this.listeners.forEach(listener => {
-      if (this._flushing !== flushId) return;
-      listener();
-    });
-  };
-  batch = cb => {
-    if (this._batching) return cb();
-    this._batching = true;
-    cb();
-    this._batching = false;
-    this._flush();
-  };
-}
-
-exports.Store = Store;
-//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["export type AnyUpdater = (...args: any[]) => any\n\nexport type Listener = () => void\n\ninterface StoreOptions<\n  TState,\n  TUpdater extends AnyUpdater = (cb: TState) => TState,\n> {\n  updateFn?: (previous: TState) => (updater: TUpdater) => TState\n  onSubscribe?: (\n    listener: Listener,\n    store: Store<TState, TUpdater>,\n  ) => () => void\n  onUpdate?: () => void\n}\n\nexport class Store<\n  TState,\n  TUpdater extends AnyUpdater = (cb: TState) => TState,\n> {\n  listeners = new Set<Listener>()\n  state: TState\n  options?: StoreOptions<TState, TUpdater>\n  _batching = false\n  _flushing = 0\n\n  constructor(initialState: TState, options?: StoreOptions<TState, TUpdater>) {\n    this.state = initialState\n    this.options = options\n  }\n\n  subscribe = (listener: Listener) => {\n    this.listeners.add(listener)\n    const unsub = this.options?.onSubscribe?.(listener, this)\n    return () => {\n      this.listeners.delete(listener)\n      unsub?.()\n    }\n  }\n\n  setState = (updater: TUpdater) => {\n    const previous = this.state\n    this.state = this.options?.updateFn\n      ? this.options.updateFn(previous)(updater)\n      : (updater as any)(previous)\n\n    // Always run onUpdate, regardless of batching\n    this.options?.onUpdate?.()\n\n    // Attempt to flush\n    this._flush()\n  }\n\n  _flush = () => {\n    if (this._batching) return\n    const flushId = ++this._flushing\n    this.listeners.forEach((listener) => {\n      if (this._flushing !== flushId) return\n      listener()\n    })\n  }\n\n  batch = (cb: () => void) => {\n    if (this._batching) return cb()\n    this._batching = true\n    cb()\n    this._batching = false\n    this._flush()\n  }\n}\n"],"names":["Store","listeners","Set","_batching","_flushing","constructor","initialState","options","state","subscribe","listener","add","unsub","onSubscribe","delete","setState","updater","previous","updateFn","onUpdate","_flush","flushId","forEach","batch","cb"],"mappings":";;;;;;;;;;;;;;AAgBO,MAAMA,KAAK,CAGhB;EACAC,SAAS,GAAG,IAAIC,GAAG,EAAY,CAAA;AAG/BC,EAAAA,SAAS,GAAG,KAAK,CAAA;AACjBC,EAAAA,SAAS,GAAG,CAAC,CAAA;AAEbC,EAAAA,WAAW,CAACC,YAAoB,EAAEC,OAAwC,EAAE;IAC1E,IAAI,CAACC,KAAK,GAAGF,YAAY,CAAA;IACzB,IAAI,CAACC,OAAO,GAAGA,OAAO,CAAA;AACxB,GAAA;EAEAE,SAAS,GAAIC,QAAkB,IAAK;AAClC,IAAA,IAAI,CAACT,SAAS,CAACU,GAAG,CAACD,QAAQ,CAAC,CAAA;IAC5B,MAAME,KAAK,GAAG,IAAI,CAACL,OAAO,EAAEM,WAAW,GAAGH,QAAQ,EAAE,IAAI,CAAC,CAAA;AACzD,IAAA,OAAO,MAAM;AACX,MAAA,IAAI,CAACT,SAAS,CAACa,MAAM,CAACJ,QAAQ,CAAC,CAAA;AAC/BE,MAAAA,KAAK,IAAI,CAAA;KACV,CAAA;GACF,CAAA;EAEDG,QAAQ,GAAIC,OAAiB,IAAK;AAChC,IAAA,MAAMC,QAAQ,GAAG,IAAI,CAACT,KAAK,CAAA;IAC3B,IAAI,CAACA,KAAK,GAAG,IAAI,CAACD,OAAO,EAAEW,QAAQ,GAC/B,IAAI,CAACX,OAAO,CAACW,QAAQ,CAACD,QAAQ,CAAC,CAACD,OAAO,CAAC,GACvCA,OAAO,CAASC,QAAQ,CAAC,CAAA;;AAE9B;AACA,IAAA,IAAI,CAACV,OAAO,EAAEY,QAAQ,IAAI,CAAA;;AAE1B;IACA,IAAI,CAACC,MAAM,EAAE,CAAA;GACd,CAAA;AAEDA,EAAAA,MAAM,GAAG,MAAM;IACb,IAAI,IAAI,CAACjB,SAAS,EAAE,OAAA;AACpB,IAAA,MAAMkB,OAAO,GAAG,EAAE,IAAI,CAACjB,SAAS,CAAA;AAChC,IAAA,IAAI,CAACH,SAAS,CAACqB,OAAO,CAAEZ,QAAQ,IAAK;AACnC,MAAA,IAAI,IAAI,CAACN,SAAS,KAAKiB,OAAO,EAAE,OAAA;AAChCX,MAAAA,QAAQ,EAAE,CAAA;AACZ,KAAC,CAAC,CAAA;GACH,CAAA;EAEDa,KAAK,GAAIC,EAAc,IAAK;AAC1B,IAAA,IAAI,IAAI,CAACrB,SAAS,EAAE,OAAOqB,EAAE,EAAE,CAAA;IAC/B,IAAI,CAACrB,SAAS,GAAG,IAAI,CAAA;AACrBqB,IAAAA,EAAE,EAAE,CAAA;IACJ,IAAI,CAACrB,SAAS,GAAG,KAAK,CAAA;IACtB,IAAI,CAACiB,MAAM,EAAE,CAAA;GACd,CAAA;AACH;;;;"}

package/build/esm/index.js

@@ -1,55 +0,0 @@
-/**
- * store
- *
- * Copyright (c) TanStack
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE.md file in the root directory of this source tree.
- *
- * @license MIT
- */
-class Store {
-  listeners = new Set();
-  _batching = false;
-  _flushing = 0;
-  constructor(initialState, options) {
-    this.state = initialState;
-    this.options = options;
-  }
-  subscribe = listener => {
-    this.listeners.add(listener);
-    const unsub = this.options?.onSubscribe?.(listener, this);
-    return () => {
-      this.listeners.delete(listener);
-      unsub?.();
-    };
-  };
-  setState = updater => {
-    const previous = this.state;
-    this.state = this.options?.updateFn ? this.options.updateFn(previous)(updater) : updater(previous);
-
-    // Always run onUpdate, regardless of batching
-    this.options?.onUpdate?.();
-
-    // Attempt to flush
-    this._flush();
-  };
-  _flush = () => {
-    if (this._batching) return;
-    const flushId = ++this._flushing;
-    this.listeners.forEach(listener => {
-      if (this._flushing !== flushId) return;
-      listener();
-    });
-  };
-  batch = cb => {
-    if (this._batching) return cb();
-    this._batching = true;
-    cb();
-    this._batching = false;
-    this._flush();
-  };
-}
-
-export { Store };
-//# sourceMappingURL=index.js.map

package/build/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["export type AnyUpdater = (...args: any[]) => any\n\nexport type Listener = () => void\n\ninterface StoreOptions<\n  TState,\n  TUpdater extends AnyUpdater = (cb: TState) => TState,\n> {\n  updateFn?: (previous: TState) => (updater: TUpdater) => TState\n  onSubscribe?: (\n    listener: Listener,\n    store: Store<TState, TUpdater>,\n  ) => () => void\n  onUpdate?: () => void\n}\n\nexport class Store<\n  TState,\n  TUpdater extends AnyUpdater = (cb: TState) => TState,\n> {\n  listeners = new Set<Listener>()\n  state: TState\n  options?: StoreOptions<TState, TUpdater>\n  _batching = false\n  _flushing = 0\n\n  constructor(initialState: TState, options?: StoreOptions<TState, TUpdater>) {\n    this.state = initialState\n    this.options = options\n  }\n\n  subscribe = (listener: Listener) => {\n    this.listeners.add(listener)\n    const unsub = this.options?.onSubscribe?.(listener, this)\n    return () => {\n      this.listeners.delete(listener)\n      unsub?.()\n    }\n  }\n\n  setState = (updater: TUpdater) => {\n    const previous = this.state\n    this.state = this.options?.updateFn\n      ? this.options.updateFn(previous)(updater)\n      : (updater as any)(previous)\n\n    // Always run onUpdate, regardless of batching\n    this.options?.onUpdate?.()\n\n    // Attempt to flush\n    this._flush()\n  }\n\n  _flush = () => {\n    if (this._batching) return\n    const flushId = ++this._flushing\n    this.listeners.forEach((listener) => {\n      if (this._flushing !== flushId) return\n      listener()\n    })\n  }\n\n  batch = (cb: () => void) => {\n    if (this._batching) return cb()\n    this._batching = true\n    cb()\n    this._batching = false\n    this._flush()\n  }\n}\n"],"names":["Store","listeners","Set","_batching","_flushing","constructor","initialState","options","state","subscribe","listener","add","unsub","onSubscribe","delete","setState","updater","previous","updateFn","onUpdate","_flush","flushId","forEach","batch","cb"],"mappings":";;;;;;;;;;AAgBO,MAAMA,KAAK,CAGhB;EACAC,SAAS,GAAG,IAAIC,GAAG,EAAY,CAAA;AAG/BC,EAAAA,SAAS,GAAG,KAAK,CAAA;AACjBC,EAAAA,SAAS,GAAG,CAAC,CAAA;AAEbC,EAAAA,WAAW,CAACC,YAAoB,EAAEC,OAAwC,EAAE;IAC1E,IAAI,CAACC,KAAK,GAAGF,YAAY,CAAA;IACzB,IAAI,CAACC,OAAO,GAAGA,OAAO,CAAA;AACxB,GAAA;EAEAE,SAAS,GAAIC,QAAkB,IAAK;AAClC,IAAA,IAAI,CAACT,SAAS,CAACU,GAAG,CAACD,QAAQ,CAAC,CAAA;IAC5B,MAAME,KAAK,GAAG,IAAI,CAACL,OAAO,EAAEM,WAAW,GAAGH,QAAQ,EAAE,IAAI,CAAC,CAAA;AACzD,IAAA,OAAO,MAAM;AACX,MAAA,IAAI,CAACT,SAAS,CAACa,MAAM,CAACJ,QAAQ,CAAC,CAAA;AAC/BE,MAAAA,KAAK,IAAI,CAAA;KACV,CAAA;GACF,CAAA;EAEDG,QAAQ,GAAIC,OAAiB,IAAK;AAChC,IAAA,MAAMC,QAAQ,GAAG,IAAI,CAACT,KAAK,CAAA;IAC3B,IAAI,CAACA,KAAK,GAAG,IAAI,CAACD,OAAO,EAAEW,QAAQ,GAC/B,IAAI,CAACX,OAAO,CAACW,QAAQ,CAACD,QAAQ,CAAC,CAACD,OAAO,CAAC,GACvCA,OAAO,CAASC,QAAQ,CAAC,CAAA;;AAE9B;AACA,IAAA,IAAI,CAACV,OAAO,EAAEY,QAAQ,IAAI,CAAA;;AAE1B;IACA,IAAI,CAACC,MAAM,EAAE,CAAA;GACd,CAAA;AAEDA,EAAAA,MAAM,GAAG,MAAM;IACb,IAAI,IAAI,CAACjB,SAAS,EAAE,OAAA;AACpB,IAAA,MAAMkB,OAAO,GAAG,EAAE,IAAI,CAACjB,SAAS,CAAA;AAChC,IAAA,IAAI,CAACH,SAAS,CAACqB,OAAO,CAAEZ,QAAQ,IAAK;AACnC,MAAA,IAAI,IAAI,CAACN,SAAS,KAAKiB,OAAO,EAAE,OAAA;AAChCX,MAAAA,QAAQ,EAAE,CAAA;AACZ,KAAC,CAAC,CAAA;GACH,CAAA;EAEDa,KAAK,GAAIC,EAAc,IAAK;AAC1B,IAAA,IAAI,IAAI,CAACrB,SAAS,EAAE,OAAOqB,EAAE,EAAE,CAAA;IAC/B,IAAI,CAACrB,SAAS,GAAG,IAAI,CAAA;AACrBqB,IAAAA,EAAE,EAAE,CAAA;IACJ,IAAI,CAACrB,SAAS,GAAG,KAAK,CAAA;IACtB,IAAI,CAACiB,MAAM,EAAE,CAAA;GACd,CAAA;AACH;;;;"}