fix: drop support for jotai store v1 (#173)

* fix: drop support for jotai store v1

* docs: update docs around prerequisites

* fix: build error

Author: arjunvegda

README.md

@@ -8,14 +8,13 @@
 
 - Debug 🐞 atom values with ease
 - ⏳ Time-travel through your atoms and find bugs faster than before
-  (recommended jotai `>=2.2.0`)
 - Out-of-the-box 🔌 support for async/suspendible atoms
 - Built-in Dark mode 🌗
 - ✅ Supports custom `store`
 - ✅ Works with provider-less mode
 - ✅ Works with Next.js
 - ✅ Supports custom `nonce` for CSP
-- ✅ Hides private atoms with ability to configure (requires Jotai `>=2.0.3`)
+- ✅ Hides private atoms with ability to configure
 - ✅ Tree-shakable and built for non-production environments
 - ✅ Parses all the JavaScript values with JSON Tree view
 - ✅ Diff checking with additions and deletion highlights
@@ -30,7 +29,7 @@
 
 ## ☝️ Prerequisites
 
-- Jotai version `>=2.1.0.`
+- Jotai version `>=2.9.0`
 - React version `>=17.0.0`
 
 ## 📦 Setup

package.json

@@ -140,7 +140,7 @@
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-watch-typeahead": "^2.2.2",
-    "jotai": "^2.9.1",
+    "jotai": "^2.11.3",
     "jotai-tanstack-query": "^0.7.2",
     "lint-staged": "^15.3.0",
     "postcss": "^8.4.49",

pnpm-lock.yaml

@@ -1,10 +1,6 @@
 import { createContext, useContext } from 'react';
-import { createStore } from 'jotai/vanilla';
-import { Store } from 'src/types';
+import type { Store } from 'src/types';
 
-// Don't use this directly in your components
-// use `useDevtoolsJotaiStoreOptions` instead
-export const internalJotaiStore = createStore();
 export const InternalDevToolsContext = createContext<Store | undefined>(
   undefined,
 );

src/DevTools/internal-jotai-store.ts

@@ -1,15 +1,14 @@
 import { useStore } from 'jotai/react';
+import type { Atom, WritableAtom, createStore } from 'jotai/vanilla';
 import type {
-  Atom,
-  WritableAtom,
-  createStore as createStoreV1,
-} from 'jotai/vanilla';
-import { INTERNAL_DevStoreRev4, INTERNAL_PrdStore } from 'jotai/vanilla/store';
+  INTERNAL_DevStoreRev4,
+  INTERNAL_PrdStore,
+} from 'jotai/vanilla/store';
 
-export type StoreV1 = ReturnType<typeof createStoreV1>;
-export type StoreV2 = INTERNAL_DevStoreRev4 & INTERNAL_PrdStore;
+export type StoreWithoutDevMethods = ReturnType<typeof createStore>;
+export type StoreWithDevMethods = INTERNAL_DevStoreRev4 & INTERNAL_PrdStore;
 
-export type Store = StoreV1 | StoreV2;
+export type Store = StoreWithoutDevMethods | StoreWithDevMethods;
 
 export type Options = Parameters<typeof useStore>[0];
 

src/types.ts

@@ -4,8 +4,7 @@ import {
   AnyAtomError,
   AnyAtomValue,
   Store,
-  StoreV1,
-  StoreV2,
+  StoreWithDevMethods,
 } from '../../types';
 
 type DevSubscribeStoreListener = (action: {
@@ -34,23 +33,19 @@ type DevToolsStoreMethods = {
 
 type WithDevToolsStore<S extends Store> = S & DevToolsStoreMethods;
 
-const isStoreV2 = (store: Store | undefined): store is StoreV2 => {
+const isDevStore = (store: Store | undefined): store is StoreWithDevMethods => {
   return store ? 'dev4_get_internal_weak_map' in store : false;
 };
 
-const isStoreV1 = (store: Store | undefined): store is StoreV1 => {
-  return !isStoreV2(store);
-};
-
 export const isDevToolsStore = (
   store: Store | WithDevToolsStore<Store>,
 ): store is WithDevToolsStore<Store> => {
   return 'subscribeStore' in store;
 };
 
-const __composeV2StoreWithDevTools = (
-  store: StoreV2,
-): WithDevToolsStore<StoreV2> => {
+const __composeDevTools = (
+  store: StoreWithDevMethods,
+): WithDevToolsStore<StoreWithDevMethods> => {
   const { sub, set, get } = store;
   const storeListeners: Set<DevSubscribeStoreListener> = new Set();
 
@@ -159,83 +154,6 @@ const __composeV2StoreWithDevTools = (
   return store as typeof store & DevToolsStoreMethods;
 };
 
-const __composeV1StoreWithDevTools = (
-  store: StoreV1,
-): StoreV1 | WithDevToolsStore<StoreV1> => {
-  if (
-    'dev_subscribe_store' in store &&
-    'dev_get_mounted_atoms' in store &&
-    'dev_get_atom_state' in store &&
-    'dev_get_mounted' in store &&
-    'dev_restore_atoms' in store
-  ) {
-    const {
-      dev_subscribe_store,
-      dev_get_mounted_atoms,
-      dev_get_atom_state,
-      dev_get_mounted,
-      dev_restore_atoms,
-    } = store;
-
-    (store as WithDevToolsStore<typeof store>).subscribeStore = (l) => {
-      const cb: Parameters<typeof dev_subscribe_store>[0] = (action) => {
-        if (action.type === 'write' || action.type === 'async-write') {
-          l({ type: 'set' });
-        }
-
-        if (action.type === 'sub') {
-          l({ type: 'sub' });
-        }
-
-        if (action.type === 'unsub') {
-          l({ type: 'unsub' });
-        }
-
-        if (action.type === 'restore') {
-          l({ type: 'restore' });
-        }
-      };
-
-      return dev_subscribe_store(cb, 2);
-    };
-
-    (store as WithDevToolsStore<typeof store>).getMountedAtoms = () => {
-      return dev_get_mounted_atoms();
-    };
-
-    (store as WithDevToolsStore<typeof store>).getAtomState = (atom) => {
-      const aState = dev_get_atom_state(atom);
-
-      if (aState) {
-        const d = new Set(aState.d.keys());
-        d.delete(atom);
-
-        if ('v' in aState) {
-          return { v: aState.v, d };
-        }
-        if ('e' in aState) {
-          return { e: aState.e, d };
-        }
-
-        return undefined;
-      }
-    };
-
-    (store as WithDevToolsStore<typeof store>).getMountedAtomState = (atom) => {
-      const mounted = dev_get_mounted(atom);
-      return mounted;
-    };
-
-    (store as WithDevToolsStore<typeof store>).restoreAtoms = (values) => {
-      dev_restore_atoms(values);
-    };
-
-    return store as typeof store & DevToolsStoreMethods;
-  }
-
-  return store;
-};
-
 export const composeWithDevTools = (
   store: Store,
 ): typeof store | WithDevToolsStore<typeof store> => {
@@ -244,12 +162,8 @@ export const composeWithDevTools = (
     return store;
   }
 
-  if (isStoreV2(store)) {
-    return __composeV2StoreWithDevTools(store);
-  }
-
-  if (isStoreV1(store)) {
-    return __composeV1StoreWithDevTools(store);
+  if (isDevStore(store)) {
+    return __composeDevTools(store);
   }
 
   return store;