Skip to content

Commit 5bf15c2

Browse files
committed
Merge branch 'alpha' into feature/suspense
# Conflicts: # pnpm-lock.yaml
2 parents 9d67d8b + e310db4 commit 5bf15c2

35 files changed

+777
-514
lines changed

docs/svelte/reactivity.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,47 +3,47 @@ id: reactivity
33
title: Reactivity
44
---
55

6-
Svelte uses a compiler to build your code which optimises rendering. By default, variables will run once, unless they are referenced in your markup. To be able to react to changes in options you need to use [stores](https://svelte.dev/tutorial/writable-stores).
6+
Svelte uses a compiler to build your code which optimises rendering. By default, components run once, unless they are referenced in your markup. To be able to react to changes in options you need to use [stores](https://svelte.dev/docs/svelte-store).
77

8-
In the below example, the `refetchInterval` option is set from the variable `intervalMs`, which is edited by the input field. However, as the query is not told it should react to changes in `intervalMs`, `refetchInterval` will not change when the input value changes.
8+
In the below example, the `refetchInterval` option is set from the variable `intervalMs`, which is bound to the input field. However, as the query is not able to react to changes in `intervalMs`, `refetchInterval` will not change when the input value changes.
99

1010
```markdown
11-
<script>
11+
<script lang="ts">
1212
import { createQuery } from '@tanstack/svelte-query'
1313

14-
let intervalMs = 1000
15-
1614
const endpoint = 'http://localhost:5173/api/data'
1715

16+
let intervalMs = 1000
17+
1818
const query = createQuery({
1919
queryKey: ['refetch'],
2020
queryFn: async () => await fetch(endpoint).then((r) => r.json()),
2121
refetchInterval: intervalMs,
2222
})
2323
</script>
2424

25-
<input bind:value={intervalMs} type="number" />
25+
<input type="number" bind:value={intervalMs} />
2626
```
2727

28-
To solve this, create a store for the options and use it as input for the query. Update the options store when the value changes and the query will react to the change.
28+
To solve this, we can convert `intervalMs` into a writable store. The query options can then be turned into a derived store, which will be passed into the function with true reactivity.
2929

3030
```markdown
31-
<script>
31+
<script lang="ts">
32+
import { derived, writable } from 'svelte/store'
3233
import { createQuery } from '@tanstack/svelte-query'
3334

3435
const endpoint = 'http://localhost:5173/api/data'
3536

36-
const queryOptions = writable({
37-
queryKey: ['refetch'],
38-
queryFn: async () => await fetch(endpoint).then((r) => r.json()),
39-
refetchInterval: 1000,
40-
})
41-
const query = createQuery(queryOptions)
37+
const intervalMs = writable(1000)
4238

43-
function updateRefetchInterval(event) {
44-
$queryOptions.refetchInterval = event.target.valueAsNumber
45-
}
39+
const query = createQuery(
40+
derived(intervalMs, ($intervalMs) => ({
41+
queryKey: ['refetch'],
42+
queryFn: async () => await fetch(endpoint).then((r) => r.json()),
43+
refetchInterval: $intervalMs,
44+
}))
45+
)
4646
</script>
4747

48-
<input type="number" on:input={updateRefetchInterval} />
48+
<input type="number" bind:value={$intervalMs} />
4949
```

examples/svelte/auto-refetching/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
"devDependencies": {
1616
"@sveltejs/adapter-auto": "^2.1.0",
1717
"@sveltejs/kit": "^1.19.0",
18-
"svelte": "^3.54.0",
19-
"svelte-check": "^3.4.3",
18+
"svelte": "^4.0.0",
19+
"svelte-check": "^3.4.4",
2020
"tslib": "^2.5.2",
2121
"typescript": "^5.0.4",
2222
"vite": "^4.2.0"

examples/svelte/basic/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
"devDependencies": {
1616
"@sveltejs/adapter-auto": "^2.1.0",
1717
"@sveltejs/kit": "^1.19.0",
18-
"svelte": "^3.54.0",
19-
"svelte-check": "^3.4.3",
18+
"svelte": "^4.0.0",
19+
"svelte-check": "^3.4.4",
2020
"tslib": "^2.5.2",
2121
"typescript": "^5.0.4",
2222
"vite": "^4.2.0"

examples/svelte/load-more-infinite-scroll/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
"devDependencies": {
1616
"@sveltejs/adapter-auto": "^2.1.0",
1717
"@sveltejs/kit": "^1.19.0",
18-
"svelte": "^3.54.0",
19-
"svelte-check": "^3.4.3",
18+
"svelte": "^4.0.0",
19+
"svelte-check": "^3.4.4",
2020
"tslib": "^2.5.2",
2121
"typescript": "^5.0.4",
2222
"vite": "^4.2.0"

examples/svelte/optimistic-updates-typescript/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
"devDependencies": {
1616
"@sveltejs/adapter-auto": "^2.1.0",
1717
"@sveltejs/kit": "^1.19.0",
18-
"svelte": "^3.54.0",
19-
"svelte-check": "^3.4.3",
18+
"svelte": "^4.0.0",
19+
"svelte-check": "^3.4.4",
2020
"tslib": "^2.5.2",
2121
"typescript": "^5.0.4",
2222
"vite": "^4.2.0"

examples/svelte/playground/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
"devDependencies": {
1616
"@sveltejs/adapter-auto": "^2.1.0",
1717
"@sveltejs/kit": "^1.19.0",
18-
"svelte": "^3.54.0",
19-
"svelte-check": "^3.4.3",
18+
"svelte": "^4.0.0",
19+
"svelte-check": "^3.4.4",
2020
"tslib": "^2.5.2",
2121
"typescript": "^5.0.4",
2222
"vite": "^4.2.0"

examples/svelte/simple/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313
"@tanstack/svelte-query-devtools": "^5.0.0-alpha.39"
1414
},
1515
"devDependencies": {
16-
"@sveltejs/vite-plugin-svelte": "^2.4.0",
16+
"@sveltejs/vite-plugin-svelte": "^2.4.2",
1717
"@tsconfig/svelte": "^4.0.1",
18-
"svelte": "^3.54.0",
19-
"svelte-check": "^3.4.3",
18+
"svelte": "^4.0.0",
19+
"svelte-check": "^3.4.4",
2020
"tslib": "^2.5.2",
2121
"typescript": "^5.0.4",
2222
"vite": "^4.2.0"

examples/svelte/ssr/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
"devDependencies": {
1616
"@sveltejs/adapter-auto": "^2.1.0",
1717
"@sveltejs/kit": "^1.19.0",
18-
"svelte": "^3.54.0",
19-
"svelte-check": "^3.4.3",
18+
"svelte": "^4.0.0",
19+
"svelte-check": "^3.4.4",
2020
"tslib": "^2.5.2",
2121
"typescript": "^5.0.4",
2222
"vite": "^4.2.0"

examples/svelte/star-wars/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
"@sveltejs/kit": "^1.19.0",
1818
"autoprefixer": "^10.4.14",
1919
"postcss": "^8.4.23",
20-
"svelte": "^3.54.0",
21-
"svelte-check": "^3.4.3",
20+
"svelte": "^4.0.0",
21+
"svelte-check": "^3.4.4",
2222
"tailwindcss": "^3.3.2",
2323
"tslib": "^2.5.2",
2424
"typescript": "^5.0.4",

package.json

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
},
3131
"namespace": "@tanstack",
3232
"devDependencies": {
33+
"@arethetypeswrong/cli": "^0.4.2",
3334
"@babel/core": "^7.21.8",
3435
"@babel/preset-env": "^7.21.5",
3536
"@babel/preset-react": "^7.18.6",
@@ -71,13 +72,14 @@
7172
"eslint-plugin-react": "^7.32.2",
7273
"eslint-plugin-react-hooks": "^4.6.0",
7374
"git-log-parser": "^1.2.0",
75+
"jsdom": "^22.0.0",
7476
"jsonfile": "^6.1.0",
7577
"luxon": "^3.3.0",
76-
"nx": "^16.3.1",
78+
"nx": "^16.5.0",
7779
"nx-cloud": "^16.0.5",
7880
"prettier": "^2.8.8",
79-
"prettier-plugin-svelte": "^2.10.0",
80-
"publint": "^0.1.12",
81+
"prettier-plugin-svelte": "^2.10.1",
82+
"publint": "^0.1.15",
8183
"react": "^18.2.0",
8284
"react-dom": "^18.2.0",
8385
"rimraf": "^5.0.1",
@@ -89,7 +91,7 @@
8991
"semver": "^7.5.1",
9092
"solid-js": "^1.6.13",
9193
"stream-to-array": "^2.3.0",
92-
"tsup": "^7.0.0",
94+
"tsup": "^7.1.0",
9395
"type-fest": "^3.11.0",
9496
"typescript": "^5.0.4",
9597
"vitest": "^0.27.1",

packages/eslint-plugin-query/package.json

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@tanstack/eslint-plugin-query",
3-
"version": "5.0.0-alpha.68",
3+
"version": "5.0.0-alpha.74",
44
"description": "ESLint plugin for TanStack Query",
55
"author": "Eliya Cohen",
66
"license": "MIT",
@@ -16,10 +16,14 @@
1616
"module": "build/lib/index.js",
1717
"exports": {
1818
".": {
19-
"types": "./build/lib/index.d.ts",
20-
"import": "./build/lib/index.js",
21-
"require": "./build/lib/index.cjs",
22-
"default": "./build/lib/index.cjs"
19+
"import": {
20+
"types": "./build/lib/index.d.ts",
21+
"default": "./build/lib/index.js"
22+
},
23+
"require": {
24+
"types": "./build/lib/index.d.cts",
25+
"default": "./build/lib/index.cjs"
26+
}
2327
},
2428
"./package.json": "./package.json"
2529
},
@@ -30,19 +34,17 @@
3034
"test:types": "tsc --noEmit",
3135
"test:lib": "vitest run --coverage",
3236
"test:lib:dev": "pnpm run test:lib --watch",
33-
"test:build": "publint --strict",
34-
"build": "pnpm build:tsup && pnpm build:types",
35-
"build:tsup": "tsup",
36-
"build:types": "tsc --emitDeclarationOnly"
37+
"test:build": "publint --strict && attw --pack",
38+
"build": "tsup"
3739
},
3840
"files": [
3941
"build",
4042
"src"
4143
],
44+
"dependencies": {
45+
"@typescript-eslint/utils": "^5.54.0"
46+
},
4247
"devDependencies": {
43-
"@typescript-eslint/eslint-plugin": "^5.54.0",
44-
"@typescript-eslint/parser": "^5.54.0",
45-
"@typescript-eslint/utils": "^5.54.0",
4648
"eslint": "^8.34.0"
4749
},
4850
"peerDependencies": {

packages/eslint-plugin-query/tsup.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export default defineConfig({
77
format: ['cjs', 'esm'],
88
target: ['es2020', 'node16'],
99
outDir: 'build/lib',
10-
external: [/eslint/],
10+
dts: true,
1111
sourcemap: true,
1212
clean: true,
1313
})

packages/query-devtools/rollup.config.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ export function createQueryDevtoolsConfig() {
88
withSolid({
99
input: `./src/index.tsx`,
1010
targets: ['esm', 'cjs'],
11-
external: [],
1211
})
1312
)
1413

14+
solidRollupOptions.external = []
15+
1516
const outputs = !solidRollupOptions.output
1617
? []
1718
: Array.isArray(solidRollupOptions.output)

packages/solid-query/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@tanstack/solid-query",
3-
"version": "5.0.0-alpha.70",
3+
"version": "5.0.0-alpha.75",
44
"description": "Primitives for managing, caching and syncing asynchronous and remote data in Solid",
55
"author": "tannerlinsley",
66
"license": "MIT",

packages/solid-query/rollup.config.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ export function createSolidQueryConfig() {
88
withSolid({
99
input: `./src/index.ts`,
1010
targets: ['esm', 'cjs'],
11-
external: ['@tanstack/query-core'],
1211
})
1312
)
1413

packages/solid-query/src/QueryClientProvider.tsx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,10 @@ export const QueryClientContext = createContext<QueryClient | undefined>(
77
)
88

99
export const useQueryClient = (queryClient?: QueryClient) => {
10-
const client = useContext(QueryClientContext)
11-
1210
if (queryClient) {
1311
return queryClient
1412
}
13+
const client = useContext(QueryClientContext)
1514

1615
if (!client) {
1716
throw new Error('No QueryClient set, use QueryClientProvider to set one')

packages/solid-query/src/__tests__/QueryClientProvider.test.tsx

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,4 +161,21 @@ describe('QueryClientProvider', () => {
161161
consoleMock.mockRestore()
162162
})
163163
})
164+
165+
it('should not throw an error if user provides custom query client', () => {
166+
const consoleMock = vi
167+
.spyOn(console, 'error')
168+
.mockImplementation(() => undefined)
169+
170+
function Page() {
171+
const client = createQueryClient()
172+
useQueryClient(client)
173+
return null
174+
}
175+
176+
render(() => <Page />)
177+
expect(consoleMock).not.toHaveBeenCalled()
178+
179+
consoleMock.mockRestore()
180+
})
164181
})

packages/svelte-query-devtools/package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@tanstack/svelte-query-devtools",
3-
"version": "5.0.0-alpha.72",
3+
"version": "5.0.0-alpha.78",
44
"description": "Developer tools to interact with and visualize the TanStack/svelte-query cache",
55
"author": "Lachlan Collins",
66
"license": "MIT",
@@ -39,18 +39,18 @@
3939
"esm-env": "^1.0.0"
4040
},
4141
"devDependencies": {
42-
"@sveltejs/package": "^2.0.2",
43-
"@sveltejs/vite-plugin-svelte": "^2.4.0",
42+
"@sveltejs/package": "^2.1.0",
43+
"@sveltejs/vite-plugin-svelte": "^2.4.2",
4444
"@tanstack/svelte-query": "workspace:*",
45-
"eslint-plugin-svelte": "^2.29.0",
46-
"svelte": "^3.54.0",
47-
"svelte-check": "^3.4.3",
45+
"eslint-plugin-svelte": "^2.32.0",
46+
"svelte": "^4.0.0",
47+
"svelte-check": "^3.4.4",
4848
"tslib": "^2.5.2",
4949
"typescript": "^5.0.4",
5050
"vite": "^4.2.0"
5151
},
5252
"peerDependencies": {
5353
"@tanstack/svelte-query": "workspace:*",
54-
"svelte": "^3.54.0"
54+
"svelte": ">=3 <5"
5555
}
5656
}

packages/svelte-query-devtools/src/Devtools.svelte

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,23 @@
2020
let devtools: TanstackQueryDevtools | undefined
2121
2222
if (DEV && BROWSER) {
23-
onMount(async () => {
24-
const QueryDevtools = (await import('@tanstack/query-devtools'))
25-
.TanstackQueryDevtools
26-
devtools = new QueryDevtools({
27-
client,
28-
queryFlavor: 'Svelte Query',
29-
version: '5',
30-
onlineManager,
31-
buttonPosition,
32-
position,
33-
initialIsOpen,
34-
errorTypes,
35-
})
23+
onMount(() => {
24+
import('@tanstack/query-devtools').then((m) => {
25+
const QueryDevtools = m.TanstackQueryDevtools
26+
27+
devtools = new QueryDevtools({
28+
client,
29+
queryFlavor: 'Svelte Query',
30+
version: '5',
31+
onlineManager,
32+
buttonPosition,
33+
position,
34+
initialIsOpen,
35+
errorTypes,
36+
})
3637
37-
devtools.mount(ref)
38+
devtools.mount(ref)
39+
})
3840
3941
return () => {
4042
devtools?.unmount()

0 commit comments

Comments
 (0)