@tanstack/react-store 0.0.1 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +28 -12
- package/src/__tests__/index.test.tsx +79 -0
- package/src/index.tsx +1 -2
- package/build/cjs/index.js +0 -49
- package/build/cjs/index.js.map +0 -1
- package/build/esm/index.js +0 -38
- package/build/esm/index.js.map +0 -1
- package/build/stats-html.html +0 -4044
- package/build/stats-react.json +0 -90
- package/build/types/index.d.ts +0 -18
- package/build/umd/index.development.js +0 -113
- package/build/umd/index.development.js.map +0 -1
- package/build/umd/index.production.js +0 -22
- package/build/umd/index.production.js.map +0 -1
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/react-store",
|
|
3
3
|
"author": "Tanner Linsley",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.1.1",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": "tanstack/react-store",
|
|
7
7
|
"homepage": "https://tanstack.com/",
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"registry": "https://registry.npmjs.org/"
|
|
11
11
|
},
|
|
12
12
|
"keywords": [
|
|
13
|
-
"
|
|
13
|
+
"store",
|
|
14
14
|
"react",
|
|
15
15
|
"typescript"
|
|
16
16
|
],
|
|
@@ -18,17 +18,27 @@
|
|
|
18
18
|
"type": "github",
|
|
19
19
|
"url": "https://github.com/sponsors/tannerlinsley"
|
|
20
20
|
},
|
|
21
|
-
"module": "build/esm/index.js",
|
|
22
|
-
"main": "build/cjs/index.js",
|
|
23
|
-
"browser": "build/umd/index.production.js",
|
|
24
|
-
"types": "build/types/index.d.ts",
|
|
25
|
-
"engines": {
|
|
26
|
-
"node": ">=12"
|
|
27
|
-
},
|
|
28
21
|
"files": [
|
|
29
|
-
"build
|
|
22
|
+
"build",
|
|
30
23
|
"src"
|
|
31
24
|
],
|
|
25
|
+
"type": "module",
|
|
26
|
+
"types": "build/legacy/index.d.ts",
|
|
27
|
+
"main": "build/legacy/index.cjs",
|
|
28
|
+
"module": "build/legacy/index.js",
|
|
29
|
+
"exports": {
|
|
30
|
+
".": {
|
|
31
|
+
"import": {
|
|
32
|
+
"types": "./build/modern/index.d.ts",
|
|
33
|
+
"default": "./build/modern/index.js"
|
|
34
|
+
},
|
|
35
|
+
"require": {
|
|
36
|
+
"types": "./build/modern/index.d.cts",
|
|
37
|
+
"default": "./build/modern/index.cjs"
|
|
38
|
+
}
|
|
39
|
+
},
|
|
40
|
+
"./package.json": "./package.json"
|
|
41
|
+
},
|
|
32
42
|
"sideEffects": false,
|
|
33
43
|
"peerDependencies": {
|
|
34
44
|
"react": ">=16",
|
|
@@ -36,12 +46,18 @@
|
|
|
36
46
|
},
|
|
37
47
|
"dependencies": {
|
|
38
48
|
"use-sync-external-store": "^1.2.0",
|
|
39
|
-
"@tanstack/store": "0.
|
|
49
|
+
"@tanstack/store": "0.1.1"
|
|
40
50
|
},
|
|
41
51
|
"devDependencies": {
|
|
42
52
|
"@types/use-sync-external-store": "^0.0.3"
|
|
43
53
|
},
|
|
44
54
|
"scripts": {
|
|
45
|
-
"
|
|
55
|
+
"clean": "rimraf ./build && rimraf ./coverage",
|
|
56
|
+
"test:eslint": "eslint --ext .ts,.tsx ./src",
|
|
57
|
+
"test:types": "tsc",
|
|
58
|
+
"test:lib": "vitest run --coverage",
|
|
59
|
+
"test:lib:dev": "pnpm run test:lib --watch",
|
|
60
|
+
"test:build": "publint --strict",
|
|
61
|
+
"build": "tsup"
|
|
46
62
|
}
|
|
47
63
|
}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
import { render, waitFor } from '@testing-library/react'
|
|
2
|
+
import '@testing-library/jest-dom'
|
|
3
|
+
import * as React from 'react'
|
|
4
|
+
import { Store } from '@tanstack/store'
|
|
5
|
+
import { useStore } from '../index'
|
|
6
|
+
import { useState } from 'react'
|
|
7
|
+
import userEvent from '@testing-library/user-event'
|
|
8
|
+
|
|
9
|
+
const user = userEvent.setup()
|
|
10
|
+
|
|
11
|
+
describe('useStore', () => {
|
|
12
|
+
it('allows us to select state using a selector', async () => {
|
|
13
|
+
const store = new Store({
|
|
14
|
+
select: 0,
|
|
15
|
+
ignored: 1,
|
|
16
|
+
})
|
|
17
|
+
|
|
18
|
+
function Comp() {
|
|
19
|
+
const storeVal = useStore(store, (state) => state.select)
|
|
20
|
+
|
|
21
|
+
return <p>Store: {storeVal}</p>
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
const { getByText } = render(<Comp />)
|
|
25
|
+
expect(getByText('Store: 0')).toBeInTheDocument()
|
|
26
|
+
})
|
|
27
|
+
|
|
28
|
+
it('only triggers a re-render when selector state is updated', async () => {
|
|
29
|
+
const store = new Store({
|
|
30
|
+
select: 0,
|
|
31
|
+
ignored: 1,
|
|
32
|
+
})
|
|
33
|
+
|
|
34
|
+
function Comp() {
|
|
35
|
+
const storeVal = useStore(store, (state) => state.select)
|
|
36
|
+
const [fn] = useState(vi.fn)
|
|
37
|
+
fn()
|
|
38
|
+
|
|
39
|
+
return (
|
|
40
|
+
<div>
|
|
41
|
+
<p>Number rendered: {fn.mock.calls.length}</p>
|
|
42
|
+
<p>Store: {storeVal}</p>
|
|
43
|
+
<button
|
|
44
|
+
onClick={() =>
|
|
45
|
+
store.setState((v) => ({
|
|
46
|
+
...v,
|
|
47
|
+
select: 10,
|
|
48
|
+
}))
|
|
49
|
+
}
|
|
50
|
+
>
|
|
51
|
+
Update select
|
|
52
|
+
</button>
|
|
53
|
+
<button
|
|
54
|
+
onClick={() =>
|
|
55
|
+
store.setState((v) => ({
|
|
56
|
+
...v,
|
|
57
|
+
ignored: 10,
|
|
58
|
+
}))
|
|
59
|
+
}
|
|
60
|
+
>
|
|
61
|
+
Update ignored
|
|
62
|
+
</button>
|
|
63
|
+
</div>
|
|
64
|
+
)
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
const { getByText } = render(<Comp />)
|
|
68
|
+
expect(getByText('Store: 0')).toBeInTheDocument()
|
|
69
|
+
expect(getByText('Number rendered: 1')).toBeInTheDocument()
|
|
70
|
+
|
|
71
|
+
await user.click(getByText('Update select'))
|
|
72
|
+
|
|
73
|
+
await waitFor(() => expect(getByText('Store: 10')).toBeInTheDocument())
|
|
74
|
+
expect(getByText('Number rendered: 2')).toBeInTheDocument()
|
|
75
|
+
|
|
76
|
+
await user.click(getByText('Update ignored'))
|
|
77
|
+
expect(getByText('Number rendered: 2')).toBeInTheDocument()
|
|
78
|
+
})
|
|
79
|
+
})
|
package/src/index.tsx
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import
|
|
2
|
-
import { AnyUpdater, Store } from '@tanstack/store'
|
|
1
|
+
import type { AnyUpdater, Store } from '@tanstack/store'
|
|
3
2
|
import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector'
|
|
4
3
|
|
|
5
4
|
export * from '@tanstack/store'
|
package/build/cjs/index.js
DELETED
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @tanstack/react-store/src/index.tsx
|
|
3
|
-
*
|
|
4
|
-
* Copyright (c) TanStack
|
|
5
|
-
*
|
|
6
|
-
* This source code is licensed under the MIT license found in the
|
|
7
|
-
* LICENSE.md file in the root directory of this source tree.
|
|
8
|
-
*
|
|
9
|
-
* @license MIT
|
|
10
|
-
*/
|
|
11
|
-
'use strict';
|
|
12
|
-
|
|
13
|
-
Object.defineProperty(exports, '__esModule', { value: true });
|
|
14
|
-
|
|
15
|
-
var withSelector = require('use-sync-external-store/shim/with-selector');
|
|
16
|
-
var store = require('@tanstack/store');
|
|
17
|
-
|
|
18
|
-
function useStore(store, selector = d => d) {
|
|
19
|
-
const slice = withSelector.useSyncExternalStoreWithSelector(store.subscribe, () => store.state, () => store.state, selector, shallow);
|
|
20
|
-
return slice;
|
|
21
|
-
}
|
|
22
|
-
function shallow(objA, objB) {
|
|
23
|
-
if (Object.is(objA, objB)) {
|
|
24
|
-
return true;
|
|
25
|
-
}
|
|
26
|
-
if (typeof objA !== 'object' || objA === null || typeof objB !== 'object' || objB === null) {
|
|
27
|
-
return false;
|
|
28
|
-
}
|
|
29
|
-
const keysA = Object.keys(objA);
|
|
30
|
-
if (keysA.length !== Object.keys(objB).length) {
|
|
31
|
-
return false;
|
|
32
|
-
}
|
|
33
|
-
for (let i = 0; i < keysA.length; i++) {
|
|
34
|
-
if (!Object.prototype.hasOwnProperty.call(objB, keysA[i]) || !Object.is(objA[keysA[i]], objB[keysA[i]])) {
|
|
35
|
-
return false;
|
|
36
|
-
}
|
|
37
|
-
}
|
|
38
|
-
return true;
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
exports.shallow = shallow;
|
|
42
|
-
exports.useStore = useStore;
|
|
43
|
-
Object.keys(store).forEach(function (k) {
|
|
44
|
-
if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
|
|
45
|
-
enumerable: true,
|
|
46
|
-
get: function () { return store[k]; }
|
|
47
|
-
});
|
|
48
|
-
});
|
|
49
|
-
//# sourceMappingURL=index.js.map
|
package/build/cjs/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":["../../src/index.tsx"],"sourcesContent":["import * as React from 'react'\nimport { AnyUpdater, Store } from '@tanstack/store'\nimport { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector'\n\nexport * from '@tanstack/store'\n\nexport type NoInfer<T> = [T][T extends any ? 0 : never]\n\nexport function useStore<\n TState,\n TSelected = NoInfer<TState>,\n TUpdater extends AnyUpdater = AnyUpdater,\n>(\n store: Store<TState, TUpdater>,\n selector: (state: NoInfer<TState>) => TSelected = (d) => d as any,\n) {\n const slice = useSyncExternalStoreWithSelector(\n store.subscribe,\n () => store.state,\n () => store.state,\n selector,\n shallow,\n )\n\n return slice\n}\n\nexport function shallow<T>(objA: T, objB: T) {\n if (Object.is(objA, objB)) {\n return true\n }\n\n if (\n typeof objA !== 'object' ||\n objA === null ||\n typeof objB !== 'object' ||\n objB === null\n ) {\n return false\n }\n\n const keysA = Object.keys(objA)\n if (keysA.length !== Object.keys(objB).length) {\n return false\n }\n\n for (let i = 0; i < keysA.length; i++) {\n if (\n !Object.prototype.hasOwnProperty.call(objB, keysA[i] as string) ||\n !Object.is(objA[keysA[i] as keyof T], objB[keysA[i] as keyof T])\n ) {\n return false\n }\n }\n return true\n}\n"],"names":["useStore","store","selector","d","slice","useSyncExternalStoreWithSelector","subscribe","state","shallow","objA","objB","Object","is","keysA","keys","length","i","prototype","hasOwnProperty","call"],"mappings":";;;;;;;;;;;;;;;;;AAQO,SAASA,QAAQA,CAKtBC,KAA8B,EAC9BC,QAA+C,GAAIC,CAAC,IAAKA,CAAQ,EACjE;EACA,MAAMC,KAAK,GAAGC,6CAAgC,CAC5CJ,KAAK,CAACK,SAAS,EACf,MAAML,KAAK,CAACM,KAAK,EACjB,MAAMN,KAAK,CAACM,KAAK,EACjBL,QAAQ,EACRM,OACF,CAAC,CAAA;AAED,EAAA,OAAOJ,KAAK,CAAA;AACd,CAAA;AAEO,SAASI,OAAOA,CAAIC,IAAO,EAAEC,IAAO,EAAE;EAC3C,IAAIC,MAAM,CAACC,EAAE,CAACH,IAAI,EAAEC,IAAI,CAAC,EAAE;AACzB,IAAA,OAAO,IAAI,CAAA;AACb,GAAA;AAEA,EAAA,IACE,OAAOD,IAAI,KAAK,QAAQ,IACxBA,IAAI,KAAK,IAAI,IACb,OAAOC,IAAI,KAAK,QAAQ,IACxBA,IAAI,KAAK,IAAI,EACb;AACA,IAAA,OAAO,KAAK,CAAA;AACd,GAAA;AAEA,EAAA,MAAMG,KAAK,GAAGF,MAAM,CAACG,IAAI,CAACL,IAAI,CAAC,CAAA;AAC/B,EAAA,IAAII,KAAK,CAACE,MAAM,KAAKJ,MAAM,CAACG,IAAI,CAACJ,IAAI,CAAC,CAACK,MAAM,EAAE;AAC7C,IAAA,OAAO,KAAK,CAAA;AACd,GAAA;AAEA,EAAA,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGH,KAAK,CAACE,MAAM,EAAEC,CAAC,EAAE,EAAE;AACrC,IAAA,IACE,CAACL,MAAM,CAACM,SAAS,CAACC,cAAc,CAACC,IAAI,CAACT,IAAI,EAAEG,KAAK,CAACG,CAAC,CAAW,CAAC,IAC/D,CAACL,MAAM,CAACC,EAAE,CAACH,IAAI,CAACI,KAAK,CAACG,CAAC,CAAC,CAAY,EAAEN,IAAI,CAACG,KAAK,CAACG,CAAC,CAAC,CAAY,CAAC,EAChE;AACA,MAAA,OAAO,KAAK,CAAA;AACd,KAAA;AACF,GAAA;AACA,EAAA,OAAO,IAAI,CAAA;AACb;;;;;;;;;;;"}
|
package/build/esm/index.js
DELETED
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @tanstack/react-store/src/index.tsx
|
|
3
|
-
*
|
|
4
|
-
* Copyright (c) TanStack
|
|
5
|
-
*
|
|
6
|
-
* This source code is licensed under the MIT license found in the
|
|
7
|
-
* LICENSE.md file in the root directory of this source tree.
|
|
8
|
-
*
|
|
9
|
-
* @license MIT
|
|
10
|
-
*/
|
|
11
|
-
import { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector';
|
|
12
|
-
export * from '@tanstack/store';
|
|
13
|
-
|
|
14
|
-
function useStore(store, selector = d => d) {
|
|
15
|
-
const slice = useSyncExternalStoreWithSelector(store.subscribe, () => store.state, () => store.state, selector, shallow);
|
|
16
|
-
return slice;
|
|
17
|
-
}
|
|
18
|
-
function shallow(objA, objB) {
|
|
19
|
-
if (Object.is(objA, objB)) {
|
|
20
|
-
return true;
|
|
21
|
-
}
|
|
22
|
-
if (typeof objA !== 'object' || objA === null || typeof objB !== 'object' || objB === null) {
|
|
23
|
-
return false;
|
|
24
|
-
}
|
|
25
|
-
const keysA = Object.keys(objA);
|
|
26
|
-
if (keysA.length !== Object.keys(objB).length) {
|
|
27
|
-
return false;
|
|
28
|
-
}
|
|
29
|
-
for (let i = 0; i < keysA.length; i++) {
|
|
30
|
-
if (!Object.prototype.hasOwnProperty.call(objB, keysA[i]) || !Object.is(objA[keysA[i]], objB[keysA[i]])) {
|
|
31
|
-
return false;
|
|
32
|
-
}
|
|
33
|
-
}
|
|
34
|
-
return true;
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
export { shallow, useStore };
|
|
38
|
-
//# sourceMappingURL=index.js.map
|
package/build/esm/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sources":["../../src/index.tsx"],"sourcesContent":["import * as React from 'react'\nimport { AnyUpdater, Store } from '@tanstack/store'\nimport { useSyncExternalStoreWithSelector } from 'use-sync-external-store/shim/with-selector'\n\nexport * from '@tanstack/store'\n\nexport type NoInfer<T> = [T][T extends any ? 0 : never]\n\nexport function useStore<\n TState,\n TSelected = NoInfer<TState>,\n TUpdater extends AnyUpdater = AnyUpdater,\n>(\n store: Store<TState, TUpdater>,\n selector: (state: NoInfer<TState>) => TSelected = (d) => d as any,\n) {\n const slice = useSyncExternalStoreWithSelector(\n store.subscribe,\n () => store.state,\n () => store.state,\n selector,\n shallow,\n )\n\n return slice\n}\n\nexport function shallow<T>(objA: T, objB: T) {\n if (Object.is(objA, objB)) {\n return true\n }\n\n if (\n typeof objA !== 'object' ||\n objA === null ||\n typeof objB !== 'object' ||\n objB === null\n ) {\n return false\n }\n\n const keysA = Object.keys(objA)\n if (keysA.length !== Object.keys(objB).length) {\n return false\n }\n\n for (let i = 0; i < keysA.length; i++) {\n if (\n !Object.prototype.hasOwnProperty.call(objB, keysA[i] as string) ||\n !Object.is(objA[keysA[i] as keyof T], objB[keysA[i] as keyof T])\n ) {\n return false\n }\n }\n return true\n}\n"],"names":["useStore","store","selector","d","slice","useSyncExternalStoreWithSelector","subscribe","state","shallow","objA","objB","Object","is","keysA","keys","length","i","prototype","hasOwnProperty","call"],"mappings":";;;;;;;;;;;;;AAQO,SAASA,QAAQA,CAKtBC,KAA8B,EAC9BC,QAA+C,GAAIC,CAAC,IAAKA,CAAQ,EACjE;EACA,MAAMC,KAAK,GAAGC,gCAAgC,CAC5CJ,KAAK,CAACK,SAAS,EACf,MAAML,KAAK,CAACM,KAAK,EACjB,MAAMN,KAAK,CAACM,KAAK,EACjBL,QAAQ,EACRM,OACF,CAAC,CAAA;AAED,EAAA,OAAOJ,KAAK,CAAA;AACd,CAAA;AAEO,SAASI,OAAOA,CAAIC,IAAO,EAAEC,IAAO,EAAE;EAC3C,IAAIC,MAAM,CAACC,EAAE,CAACH,IAAI,EAAEC,IAAI,CAAC,EAAE;AACzB,IAAA,OAAO,IAAI,CAAA;AACb,GAAA;AAEA,EAAA,IACE,OAAOD,IAAI,KAAK,QAAQ,IACxBA,IAAI,KAAK,IAAI,IACb,OAAOC,IAAI,KAAK,QAAQ,IACxBA,IAAI,KAAK,IAAI,EACb;AACA,IAAA,OAAO,KAAK,CAAA;AACd,GAAA;AAEA,EAAA,MAAMG,KAAK,GAAGF,MAAM,CAACG,IAAI,CAACL,IAAI,CAAC,CAAA;AAC/B,EAAA,IAAII,KAAK,CAACE,MAAM,KAAKJ,MAAM,CAACG,IAAI,CAACJ,IAAI,CAAC,CAACK,MAAM,EAAE;AAC7C,IAAA,OAAO,KAAK,CAAA;AACd,GAAA;AAEA,EAAA,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGH,KAAK,CAACE,MAAM,EAAEC,CAAC,EAAE,EAAE;AACrC,IAAA,IACE,CAACL,MAAM,CAACM,SAAS,CAACC,cAAc,CAACC,IAAI,CAACT,IAAI,EAAEG,KAAK,CAACG,CAAC,CAAW,CAAC,IAC/D,CAACL,MAAM,CAACC,EAAE,CAACH,IAAI,CAACI,KAAK,CAACG,CAAC,CAAC,CAAY,EAAEN,IAAI,CAACG,KAAK,CAACG,CAAC,CAAC,CAAY,CAAC,EAChE;AACA,MAAA,OAAO,KAAK,CAAA;AACd,KAAA;AACF,GAAA;AACA,EAAA,OAAO,IAAI,CAAA;AACb;;;;"}
|