@tanstack/query-persist-client-core 4.10.1 → 4.12.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Tanner Linsley
+Copyright (c) 2021-present Tanner Linsley
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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

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

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

@@ -0,0 +1,10 @@
+/// <reference types="jest" />
+import type { QueryClientConfig } from '@tanstack/query-core';
+import { QueryClient } from '@tanstack/query-core';
+export declare function createQueryClient(config?: QueryClientConfig): QueryClient;
+export declare const mockLogger: {
+    log: jest.Mock<any, any>;
+    warn: jest.Mock<any, any>;
+    error: jest.Mock<any, any>;
+};
+export declare function sleep(timeout: number): Promise<void>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tanstack/query-persist-client-core",
-  "version": "4.10.1",
-  "description": "TODO",
+  "version": "4.12.0",
+  "description": "Set of utilities for interacting with persisters, which can save your queryClient for later use",
   "author": "tannerlinsley",
   "license": "MIT",
   "repository": "tanstack/query",
@@ -28,13 +28,15 @@
     "src"
   ],
   "devDependencies": {
-    "@tanstack/query-core": "4.10.1"
+    "@tanstack/query-core": "4.12.0"
   },
   "peerDependencies": {
-    "@tanstack/query-core": "4.10.1"
+    "@tanstack/query-core": "4.12.0"
   },
   "scripts": {
     "clean": "rm -rf ./build",
-    "test:eslint": "../../node_modules/.bin/eslint --ext .ts,.tsx ./src"
+    "test:eslint": "../../node_modules/.bin/eslint --ext .ts,.tsx ./src",
+    "test:jest": "../../node_modules/.bin/jest --config ./jest.config.ts",
+    "test:dev": "pnpm run test:jest --watch"
   }
 }

package/src/__tests__/persist.test.ts

@@ -0,0 +1,45 @@
+import { createQueryClient, sleep } from './utils'
+import type { PersistedClient, Persister } from '../persist'
+import { persistQueryClientSubscribe } from '../persist'
+
+const createMockPersister = (): Persister => {
+  let storedState: PersistedClient | undefined
+
+  return {
+    async persistClient(persistClient: PersistedClient) {
+      storedState = persistClient
+    },
+    async restoreClient() {
+      await sleep(10)
+      return storedState
+    },
+    removeClient() {
+      storedState = undefined
+    },
+  }
+}
+
+describe('persistQueryClientSubscribe', () => {
+  test('should persist mutations', async () => {
+    const queryClient = createQueryClient()
+
+    const persister = createMockPersister()
+
+    const unsubscribe = persistQueryClientSubscribe({
+      queryClient,
+      persister,
+      dehydrateOptions: { shouldDehydrateMutation: () => true },
+    })
+
+    queryClient.getMutationCache().build(queryClient, {
+      mutationFn: async (text: string) => text,
+      variables: 'todo',
+    })
+
+    const result = await persister.restoreClient()
+
+    expect(result?.clientState.mutations).toHaveLength(1)
+
+    unsubscribe()
+  })
+})

package/src/__tests__/utils.ts

@@ -0,0 +1,19 @@
+import type { QueryClientConfig } from '@tanstack/query-core'
+import { QueryClient } from '@tanstack/query-core'
+
+export function createQueryClient(config?: QueryClientConfig): QueryClient {
+  jest.spyOn(console, 'error').mockImplementation(() => undefined)
+  return new QueryClient({ logger: mockLogger, ...config })
+}
+
+export const mockLogger = {
+  log: jest.fn(),
+  warn: jest.fn(),
+  error: jest.fn(),
+}
+
+export function sleep(timeout: number): Promise<void> {
+  return new Promise((resolve, _reject) => {
+    setTimeout(resolve, timeout)
+  })
+}