@tanstack/svelte-query 5.0.0-alpha.26 → 5.0.0-alpha.27

package/build/lib/__tests__/CreateMutation.svelte

@@ -0,0 +1,10 @@
+<script>import { QueryClient } from "@tanstack/query-core";
+import { setQueryClientContext } from "../context";
+import { createMutation } from "../createMutation";
+export let options;
+const queryClient = new QueryClient();
+setQueryClientContext(queryClient);
+const mutation = createMutation(options);
+</script>
+
+<button on:click={() => $mutation.mutate()}>Click</button>

package/build/lib/__tests__/CreateMutation.svelte.d.ts

@@ -0,0 +1,17 @@
+import { SvelteComponentTyped } from "svelte";
+import type { CreateMutationOptions } from '../types';
+declare const __propDef: {
+    props: {
+        options: CreateMutationOptions;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export declare type CreateMutationProps = typeof __propDef.props;
+export declare type CreateMutationEvents = typeof __propDef.events;
+export declare type CreateMutationSlots = typeof __propDef.slots;
+export default class CreateMutation extends SvelteComponentTyped<CreateMutationProps, CreateMutationEvents, CreateMutationSlots> {
+}
+export {};

package/build/lib/__tests__/CreateQueries.svelte

@@ -0,0 +1,16 @@
+<script>import { QueryClient } from "@tanstack/query-core";
+import { setQueryClientContext } from "../context";
+import { createQueries } from "../createQueries";
+export let options;
+const queryClient = new QueryClient();
+setQueryClientContext(queryClient);
+const queries = createQueries(options);
+</script>
+
+{#each $queries as query, index}
+  {#if query.isPending}
+    <p>Loading {index + 1}</p>
+  {:else if query.isSuccess}
+    <p>{query.data}</p>
+  {/if}
+{/each}

package/build/lib/__tests__/CreateQueries.svelte.d.ts

@@ -0,0 +1,19 @@
+import { SvelteComponentTyped } from "svelte";
+import type { QueriesOptions } from '../createQueries';
+declare const __propDef: {
+    props: {
+        options: {
+            queries: [...QueriesOptions<any>];
+        };
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export declare type CreateQueriesProps = typeof __propDef.props;
+export declare type CreateQueriesEvents = typeof __propDef.events;
+export declare type CreateQueriesSlots = typeof __propDef.slots;
+export default class CreateQueries extends SvelteComponentTyped<CreateQueriesProps, CreateQueriesEvents, CreateQueriesSlots> {
+}
+export {};

package/build/lib/__tests__/CreateQuery.svelte

@@ -0,0 +1,22 @@
+<script>import { QueryClient } from "@tanstack/query-core";
+import { setQueryClientContext } from "../context";
+import { createQuery } from "../createQuery";
+export let options;
+const queryClient = new QueryClient();
+setQueryClientContext(queryClient);
+const query = createQuery(options);
+</script>
+
+{#if $query.isPending}
+  <p>Loading</p>
+{:else if $query.isError}
+  <p>Error</p>
+{:else if $query.isSuccess}
+  <p>Success</p>
+{/if}
+
+<ul>
+  {#each $query.data ?? [] as entry}
+    <li>id: {entry.id}</li>
+  {/each}
+</ul>

package/build/lib/__tests__/CreateQuery.svelte.d.ts

@@ -0,0 +1,17 @@
+import { SvelteComponentTyped } from "svelte";
+import type { CreateQueryOptions, WritableOrVal } from '../types';
+declare const __propDef: {
+    props: {
+        options: WritableOrVal<CreateQueryOptions<any>>;
+    };
+    events: {
+        [evt: string]: CustomEvent<any>;
+    };
+    slots: {};
+};
+export declare type CreateQueryProps = typeof __propDef.props;
+export declare type CreateQueryEvents = typeof __propDef.events;
+export declare type CreateQuerySlots = typeof __propDef.slots;
+export default class CreateQuery extends SvelteComponentTyped<CreateQueryProps, CreateQueryEvents, CreateQuerySlots> {
+}
+export {};

package/build/lib/__tests__/createMutation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/lib/__tests__/createMutation.test.js

@@ -0,0 +1,19 @@
+import { describe, it, expect, vi } from 'vitest';
+import { fireEvent, render, waitFor } from '@testing-library/svelte';
+import CreateMutation from './CreateMutation.svelte';
+describe('createMutation', () => {
+    it('Call mutate and check function runs', async () => {
+        const mutationFn = vi.fn();
+        const rendered = render(CreateMutation, {
+            props: {
+                options: {
+                    mutationFn,
+                },
+            },
+        });
+        fireEvent.click(rendered.getByRole('button'));
+        await waitFor(() => {
+            expect(mutationFn).toHaveBeenCalledTimes(1);
+        });
+    });
+});

package/build/lib/__tests__/createQueries.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/lib/__tests__/createQueries.test.js

@@ -0,0 +1,38 @@
+import { describe, it, expect } from 'vitest';
+import { render, waitFor } from '@testing-library/svelte';
+import CreateQueries from './CreateQueries.svelte';
+import { sleep } from './utils';
+describe('createQueries', () => {
+    it('Render and wait for success', async () => {
+        const rendered = render(CreateQueries, {
+            props: {
+                options: {
+                    queries: [
+                        {
+                            queryKey: ['key-1'],
+                            queryFn: async () => {
+                                await sleep(10);
+                                return 'Success 1';
+                            },
+                        },
+                        {
+                            queryKey: ['key-2'],
+                            queryFn: async () => {
+                                await sleep(10);
+                                return 'Success 2';
+                            },
+                        },
+                    ],
+                },
+            },
+        });
+        await waitFor(() => {
+            expect(rendered.getByText('Loading 1')).toBeInTheDocument();
+            expect(rendered.getByText('Loading 2')).toBeInTheDocument();
+        });
+        await waitFor(() => {
+            expect(rendered.getByText('Success 1')).toBeInTheDocument();
+            expect(rendered.getByText('Success 2')).toBeInTheDocument();
+        });
+    });
+});

package/build/lib/__tests__/createQuery.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/lib/__tests__/createQuery.test.js

@@ -0,0 +1,57 @@
+import { describe, it, expect } from 'vitest';
+import { render, waitFor } from '@testing-library/svelte';
+import { writable } from 'svelte/store';
+import CreateQuery from './CreateQuery.svelte';
+import { sleep } from './utils';
+describe('createQuery', () => {
+    it('Render and wait for success', async () => {
+        const rendered = render(CreateQuery, {
+            props: {
+                options: {
+                    queryKey: ['test'],
+                    queryFn: async () => {
+                        await sleep(10);
+                        return 'Success';
+                    },
+                },
+            },
+        });
+        await waitFor(() => {
+            expect(rendered.getByText('Loading')).toBeInTheDocument();
+        });
+        await waitFor(() => {
+            expect(rendered.getByText('Success')).toBeInTheDocument();
+        });
+    });
+    it('should keep previous data when returned as placeholder data', async () => {
+        const options = writable({
+            queryKey: ['test', [1]],
+            queryFn: async ({ queryKey }) => {
+                await sleep(10);
+                const ids = queryKey[1];
+                if (!ids || !Array.isArray(ids))
+                    return [];
+                return ids.map((id) => ({ id }));
+            },
+            placeholderData: (previousData) => previousData,
+        });
+        const rendered = render(CreateQuery, { props: { options } });
+        await waitFor(() => {
+            expect(rendered.queryByText('id: 1')).not.toBeInTheDocument();
+            expect(rendered.queryByText('id: 2')).not.toBeInTheDocument();
+        });
+        await waitFor(() => {
+            expect(rendered.queryByText('id: 1')).toBeInTheDocument();
+            expect(rendered.queryByText('id: 2')).not.toBeInTheDocument();
+        });
+        options.update((o) => ({ ...o, queryKey: ['test', [1, 2]] }));
+        await waitFor(() => {
+            expect(rendered.queryByText('id: 1')).toBeInTheDocument();
+            expect(rendered.queryByText('id: 2')).not.toBeInTheDocument();
+        });
+        await waitFor(() => {
+            expect(rendered.queryByText('id: 1')).toBeInTheDocument();
+            expect(rendered.queryByText('id: 2')).toBeInTheDocument();
+        });
+    });
+});

package/build/lib/__tests__/utils.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import { QueryClient, type QueryClientConfig } from '../index';
+export declare function createQueryClient(config?: QueryClientConfig): QueryClient;
+export declare function mockVisibilityState(value: DocumentVisibilityState): import("vitest/dist/index-1cfc7f58").S<[], DocumentVisibilityState>;
+export declare function mockNavigatorOnLine(value: boolean): import("vitest/dist/index-1cfc7f58").S<[], boolean>;
+export declare function queryKey(): Array<string>;
+export declare function sleep(timeout: number): Promise<void>;
+export declare function simplefetcher(): Promise<string>;
+export declare function setActTimeout(fn: () => void, ms?: number): NodeJS.Timeout;

package/build/lib/__tests__/utils.js

@@ -0,0 +1,33 @@
+import { vi } from 'vitest';
+import { act } from '@testing-library/svelte';
+import { QueryClient } from '../index';
+export function createQueryClient(config) {
+    return new QueryClient(config);
+}
+export function mockVisibilityState(value) {
+    return vi.spyOn(document, 'visibilityState', 'get').mockReturnValue(value);
+}
+export function mockNavigatorOnLine(value) {
+    return vi.spyOn(navigator, 'onLine', 'get').mockReturnValue(value);
+}
+let queryKeyCount = 0;
+export function queryKey() {
+    queryKeyCount++;
+    return [`query_${queryKeyCount}`];
+}
+export function sleep(timeout) {
+    return new Promise((resolve, _reject) => {
+        setTimeout(resolve, timeout);
+    });
+}
+export async function simplefetcher() {
+    await sleep(10);
+    return 'test';
+}
+export function setActTimeout(fn, ms) {
+    return setTimeout(() => {
+        act(() => {
+            fn();
+        });
+    }, ms);
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@tanstack/svelte-query",
-  "version": "5.0.0-alpha.26",
+  "version": "5.0.0-alpha.27",
   "description": "Primitives for managing, caching and syncing asynchronous and remote data in Svelte",
-  "author": "Dre Johnson",
+  "author": "Lachlan Collins",
   "license": "MIT",
   "repository": "tanstack/query",
   "homepage": "https://tanstack.com/query",
@@ -10,9 +10,25 @@
     "type": "github",
     "url": "https://github.com/sponsors/tannerlinsley"
   },
+  "type": "module",
   "types": "build/lib/index.d.ts",
   "module": "build/lib/index.js",
-  "type": "module",
+  "svelte": "build/lib/index.js",
+  "exports": {
+    ".": {
+      "types": "./build/lib/index.d.ts",
+      "import": "./build/lib/index.js",
+      "svelte": "./build/lib/index.js",
+      "default": "./build/lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "build/lib",
+    "src",
+    "!build/lib/__tests__",
+    "!src/__tests__"
+  ],
   "devDependencies": {
     "@sveltejs/package": "^2.0.2",
     "@sveltejs/vite-plugin-svelte": "^2.0.2",
@@ -31,21 +47,12 @@
   "peerDependencies": {
     "svelte": "^3.54.0"
   },
-  "exports": {
-    "./package.json": "./package.json",
-    ".": "./build/lib/index.js"
-  },
-  "svelte": "./build/lib/index.js",
-  "files": [
-    "build/lib/*",
-    "src"
-  ],
   "scripts": {
     "clean": "rimraf ./build",
     "test:types": "svelte-check --tsconfig ./tsconfig.json",
     "test:eslint": "eslint --ext .svelte,.ts ./src",
     "test:lib": "vitest run --coverage",
     "test:lib:dev": "pnpm run test:lib --watch",
-    "build": "svelte-package --input ./src --output ./build/lib && rimraf ./build/lib/__tests__"
+    "build": "svelte-package --input ./src --output ./build/lib"
   }
 }

package/src/__tests__/CreateMutation.svelte

@@ -1,17 +0,0 @@
-<script lang="ts">
-  import {
-    createMutation,
-    QueryClient,
-    type CreateMutationOptions,
-  } from '../index'
-  import { setQueryClientContext } from '../context'
-
-  export let options: CreateMutationOptions
-
-  const queryClient = new QueryClient()
-  setQueryClientContext(queryClient)
-
-  const mutation = createMutation(options)
-</script>
-
-<button on:click={() => $mutation.mutate()}>Click</button>

package/src/__tests__/CreateQueries.svelte

@@ -1,20 +0,0 @@
-<script lang="ts">
-  import { createQueries, QueryClient } from '../index'
-  import { setQueryClientContext } from '../context'
-  import type { QueriesOptions } from '../createQueries'
-
-  export let options: { queries: [...QueriesOptions<any>] }
-
-  const queryClient = new QueryClient()
-  setQueryClientContext(queryClient)
-
-  const queries = createQueries(options)
-</script>
-
-{#each $queries as query, index}
-  {#if query.isPending}
-    <p>Loading {index + 1}</p>
-  {:else if query.isSuccess}
-    <p>{query.data}</p>
-  {/if}
-{/each}

package/src/__tests__/CreateQuery.svelte

@@ -1,30 +0,0 @@
-<script lang="ts">
-  import {
-    createQuery,
-    QueryClient,
-    type CreateQueryOptions,
-    type WritableOrVal,
-  } from '../index'
-  import { setQueryClientContext } from '../context'
-
-  export let options: WritableOrVal<CreateQueryOptions<any>>
-
-  const queryClient = new QueryClient()
-  setQueryClientContext(queryClient)
-
-  const query = createQuery(options)
-</script>
-
-{#if $query.isPending}
-  <p>Loading</p>
-{:else if $query.isError}
-  <p>Error</p>
-{:else if $query.isSuccess}
-  <p>Success</p>
-{/if}
-
-<ul>
-  {#each $query.data ?? [] as entry}
-    <li>id: {entry.id}</li>
-  {/each}
-</ul>

package/src/__tests__/createMutation.test.ts

@@ -1,24 +0,0 @@
-import { describe, it, expect, vi } from 'vitest'
-import { fireEvent, render, screen } from '@testing-library/svelte'
-import CreateMutation from './CreateMutation.svelte'
-import { sleep } from './utils'
-
-describe('createMutation', () => {
-  it('Call mutate and check function runs', async () => {
-    const mutationFn = vi.fn()
-
-    render(CreateMutation, {
-      props: {
-        options: {
-          mutationFn,
-        },
-      },
-    })
-
-    fireEvent.click(screen.getByRole('button'))
-
-    await sleep(20)
-
-    expect(mutationFn).toHaveBeenCalledTimes(1)
-  })
-})

package/src/__tests__/createQueries.test.ts

@@ -1,41 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { render, waitFor } from '@testing-library/svelte'
-import CreateQueries from './CreateQueries.svelte'
-import { sleep } from './utils'
-
-describe('createQueries', () => {
-  it('Render and wait for success', async () => {
-    const rendered = render(CreateQueries, {
-      props: {
-        options: {
-          queries: [
-            {
-              queryKey: ['key-1'],
-              queryFn: async () => {
-                await sleep(10)
-                return 'Success 1'
-              },
-            },
-            {
-              queryKey: ['key-2'],
-              queryFn: async () => {
-                await sleep(10)
-                return 'Success 2'
-              },
-            },
-          ],
-        },
-      },
-    })
-
-    await waitFor(() => {
-      expect(rendered.getByText('Loading 1')).toBeInTheDocument()
-      expect(rendered.getByText('Loading 2')).toBeInTheDocument()
-    })
-
-    await waitFor(() => {
-      expect(rendered.getByText('Success 1')).toBeInTheDocument()
-      expect(rendered.getByText('Success 2')).toBeInTheDocument()
-    })
-  })
-})

package/src/__tests__/createQuery.test.ts

@@ -1,64 +0,0 @@
-import { describe, it, expect } from 'vitest'
-import { render, waitFor } from '@testing-library/svelte'
-import { writable } from 'svelte/store'
-import CreateQuery from './CreateQuery.svelte'
-import { sleep } from './utils'
-import type { CreateQueryOptions, WritableOrVal } from '../types'
-
-describe('createQuery', () => {
-  it('Render and wait for success', async () => {
-    const rendered = render(CreateQuery, {
-      props: {
-        options: {
-          queryKey: ['test'],
-          queryFn: async () => {
-            await sleep(10)
-            return 'Success'
-          },
-        },
-      },
-    })
-
-    await waitFor(() => {
-      expect(rendered.getByText('Loading')).toBeInTheDocument()
-    })
-
-    await waitFor(() => {
-      expect(rendered.getByText('Success')).toBeInTheDocument()
-    })
-  })
-
-  it('should keep previous data when returned as placeholder data', async () => {
-    const options: WritableOrVal<CreateQueryOptions> = writable({
-      queryKey: ['test', [1]],
-      queryFn: async ({ queryKey }) => {
-        await sleep(50)
-        const ids = queryKey[1]
-        if (!ids || !Array.isArray(ids)) return []
-        return ids.map((id) => ({ id }))
-      },
-      placeholderData: (previousData: { id: number }[]) => previousData,
-    })
-    const rendered = render(CreateQuery, { props: { options } })
-
-    expect(rendered.queryByText('id: 1')).not.toBeInTheDocument()
-    expect(rendered.queryByText('id: 2')).not.toBeInTheDocument()
-
-    await sleep(100)
-
-    expect(rendered.queryByText('id: 1')).toBeInTheDocument()
-    expect(rendered.queryByText('id: 2')).not.toBeInTheDocument()
-
-    options.update((o) => ({ ...o, queryKey: ['test', [1, 2]] }))
-
-    await sleep(0)
-
-    expect(rendered.queryByText('id: 1')).toBeInTheDocument()
-    expect(rendered.queryByText('id: 2')).not.toBeInTheDocument()
-
-    await sleep(100)
-
-    expect(rendered.queryByText('id: 1')).toBeInTheDocument()
-    expect(rendered.queryByText('id: 2')).toBeInTheDocument()
-  })
-})

package/src/__tests__/utils.ts

@@ -1,40 +0,0 @@
-import { vi } from 'vitest'
-import { act } from '@testing-library/svelte'
-import { QueryClient, type QueryClientConfig } from '../index'
-
-export function createQueryClient(config?: QueryClientConfig): QueryClient {
-  return new QueryClient(config)
-}
-
-export function mockVisibilityState(value: DocumentVisibilityState) {
-  return vi.spyOn(document, 'visibilityState', 'get').mockReturnValue(value)
-}
-
-export function mockNavigatorOnLine(value: boolean) {
-  return vi.spyOn(navigator, 'onLine', 'get').mockReturnValue(value)
-}
-
-let queryKeyCount = 0
-export function queryKey(): Array<string> {
-  queryKeyCount++
-  return [`query_${queryKeyCount}`]
-}
-
-export function sleep(timeout: number): Promise<void> {
-  return new Promise((resolve, _reject) => {
-    setTimeout(resolve, timeout)
-  })
-}
-
-export async function simplefetcher() {
-  await sleep(10)
-  return 'test'
-}
-
-export function setActTimeout(fn: () => void, ms?: number) {
-  return setTimeout(() => {
-    act(() => {
-      fn()
-    })
-  }, ms)
-}