@pancakeswap/token-lists 0.0.8 → 0.0.9

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pancakeswap/token-lists@0.0.8 build /home/runner/work/pancake-frontend/pancake-frontend/packages/token-lists
+> @pancakeswap/token-lists@0.0.9 build /home/runner/work/pancake-frontend/pancake-frontend/packages/token-lists
 > tsup
 
 CLI Building entry: {"index":"./src/index.ts","react":"./react/index.ts"}
@@ -10,20 +10,20 @@
 ESM Build start
 CJS Build start
 Entry module "dist/getTokenList-YNKBKHZ3.js" is using named and default exports together. Consumers of your bundle will have to use `chunk.default` to access the default export, which may not be what you want. Use `output.exports: "named"` to disable this warning.
-ESM dist/chunk-2L3ZO4UM.mjs        1.42 KB
-ESM dist/index.mjs                 160.00 B
-ESM dist/chunk-COROHIJN.mjs        2.67 KB
-ESM dist/getTokenList-2FAKUE6D.mjs 13.40 KB
-ESM dist/react.mjs                 8.29 KB
-ESM ⚡️ Build success in 996ms
 CJS dist/chunk-4TPCCB4K.js        1.49 KB
 CJS dist/index.js                 815.00 B
 CJS dist/chunk-OGWZ2K32.js        2.83 KB
 CJS dist/getTokenList-YNKBKHZ3.js 13.76 KB
-CJS dist/react.js                 8.97 KB
-CJS ⚡️ Build success in 1012ms
+CJS dist/react.js                 9.13 KB
+CJS ⚡️ Build success in 1438ms
+ESM dist/chunk-2L3ZO4UM.mjs        1.42 KB
+ESM dist/index.mjs                 160.00 B
+ESM dist/chunk-COROHIJN.mjs        2.67 KB
+ESM dist/getTokenList-2FAKUE6D.mjs 13.40 KB
+ESM dist/react.mjs                 8.43 KB
+ESM ⚡️ Build success in 1447ms
 DTS Build start
-DTS ⚡️ Build success in 5666ms
+DTS ⚡️ Build success in 11919ms
 DTS dist/index.d.ts          1.68 KB
-DTS dist/react.d.ts          2.50 KB
+DTS dist/react.d.ts          2.52 KB
 DTS dist/types-d6730d17.d.ts 1.03 KB

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @pancakeswap/token-lists
 
+## 0.0.9
+
+### Patch Changes
+
+- d994c3335: chore: Bump up jotai
+
 ## 0.0.8
 
 ### Patch Changes

package/dist/react.d.ts

@@ -52,4 +52,4 @@ declare const createListsAtom: (storeName: string, reducer: any, initialState: a
 
 declare function useFetchListCallback(dispatch: (action?: unknown) => void): (listUrl: string, sendDispatch?: boolean) => Promise<TokenList>;
 
-export { ListsState, NEW_LIST_STATE, acceptListUpdate, addList, createListsAtom, createTokenListReducer, disableList, enableList, fetchTokenList, rejectVersionUpdate, removeList, updateListVersion, useFetchListCallback };
+export { ListByUrlState, ListsState, NEW_LIST_STATE, acceptListUpdate, addList, createListsAtom, createTokenListReducer, disableList, enableList, fetchTokenList, rejectVersionUpdate, removeList, updateListVersion, useFetchListCallback };

package/dist/react.js

@@ -152,11 +152,9 @@ var createTokenListReducer = (initialState, DEFAULT_LIST_OF_LISTS, DEFAULT_ACTIV
 function noop() {
 }
 var noopStorage = {
-  getItem: noop,
-  setItem: noop,
-  removeItem: noop,
-  keys: [],
-  getAllKeys: noop
+  getItem: () => Promise.resolve(noop()),
+  setItem: () => Promise.resolve(noop()),
+  removeItem: () => Promise.resolve(noop())
 };
 var EMPTY = Symbol();
 var createListsAtom = (storeName, reducer, initialState) => {
@@ -167,7 +165,6 @@ var createListsAtom = (storeName, reducer, initialState) => {
         storeName
       });
       return {
-        db,
         getItem: (key) => chunk4TPCCB4K_js.__async(this, null, function* () {
           const value = yield db.getItem(key);
           if (value) {
@@ -175,40 +172,36 @@ var createListsAtom = (storeName, reducer, initialState) => {
           }
           return initialState;
         }),
-        setItem: (k, v) => {
+        setItem: (k, v) => chunk4TPCCB4K_js.__async(this, null, function* () {
           if (v === EMPTY)
             return;
-          return db.setItem(k, v);
-        },
+          yield db.setItem(k, v);
+        }),
         removeItem: db.removeItem
       };
     }
     return noopStorage;
   }
-  const listsStorageAtom = utils.atomWithStorage(
-    "lists",
-    EMPTY,
-    // @ts-ignore
-    IndexedDBStorage("lists")
-  );
+  const listsStorageAtom = utils.atomWithStorage("lists", EMPTY, IndexedDBStorage("lists"));
   const defaultStateAtom = jotai.atom(
     (get) => {
-      const got = get(listsStorageAtom);
-      if (got === EMPTY) {
-        return initialState;
+      const value = get(utils.loadable(listsStorageAtom));
+      if (value.state === "hasData" && value.data !== EMPTY) {
+        return value.data;
       }
-      return got;
+      return initialState;
     },
     (get, set, action) => chunk4TPCCB4K_js.__async(void 0, null, function* () {
       set(listsStorageAtom, reducer(yield get(defaultStateAtom), action));
     })
   );
-  const isReadyAtom = jotai.atom((get) => get(listsStorageAtom) !== EMPTY);
+  const isReadyAtom = utils.loadable(listsStorageAtom);
   function useListState() {
     return jotai.useAtom(defaultStateAtom);
   }
   function useListStateReady() {
-    return jotai.useAtomValue(isReadyAtom);
+    const value = jotai.useAtomValue(isReadyAtom);
+    return value.state === "hasData" && value.data !== EMPTY;
   }
   return {
     listsAtom: defaultStateAtom,

package/dist/react.mjs

@@ -2,7 +2,7 @@ import { getVersionUpgrade } from './chunk-COROHIJN.mjs';
 import { __spreadProps, __spreadValues, __async } from './chunk-2L3ZO4UM.mjs';
 import { createAction, createReducer, nanoid } from '@reduxjs/toolkit';
 import { atom, useAtom, useAtomValue } from 'jotai';
-import { atomWithStorage } from 'jotai/utils';
+import { atomWithStorage, loadable } from 'jotai/utils';
 import localForage from 'localforage';
 import { useCallback } from 'react';
 
@@ -146,11 +146,9 @@ var createTokenListReducer = (initialState, DEFAULT_LIST_OF_LISTS, DEFAULT_ACTIV
 function noop() {
 }
 var noopStorage = {
-  getItem: noop,
-  setItem: noop,
-  removeItem: noop,
-  keys: [],
-  getAllKeys: noop
+  getItem: () => Promise.resolve(noop()),
+  setItem: () => Promise.resolve(noop()),
+  removeItem: () => Promise.resolve(noop())
 };
 var EMPTY = Symbol();
 var createListsAtom = (storeName, reducer, initialState) => {
@@ -161,7 +159,6 @@ var createListsAtom = (storeName, reducer, initialState) => {
         storeName
       });
       return {
-        db,
         getItem: (key) => __async(this, null, function* () {
           const value = yield db.getItem(key);
           if (value) {
@@ -169,40 +166,36 @@ var createListsAtom = (storeName, reducer, initialState) => {
           }
           return initialState;
         }),
-        setItem: (k, v) => {
+        setItem: (k, v) => __async(this, null, function* () {
           if (v === EMPTY)
             return;
-          return db.setItem(k, v);
-        },
+          yield db.setItem(k, v);
+        }),
         removeItem: db.removeItem
       };
     }
     return noopStorage;
   }
-  const listsStorageAtom = atomWithStorage(
-    "lists",
-    EMPTY,
-    // @ts-ignore
-    IndexedDBStorage("lists")
-  );
+  const listsStorageAtom = atomWithStorage("lists", EMPTY, IndexedDBStorage("lists"));
   const defaultStateAtom = atom(
     (get) => {
-      const got = get(listsStorageAtom);
-      if (got === EMPTY) {
-        return initialState;
+      const value = get(loadable(listsStorageAtom));
+      if (value.state === "hasData" && value.data !== EMPTY) {
+        return value.data;
       }
-      return got;
+      return initialState;
     },
     (get, set, action) => __async(void 0, null, function* () {
       set(listsStorageAtom, reducer(yield get(defaultStateAtom), action));
     })
   );
-  const isReadyAtom = atom((get) => get(listsStorageAtom) !== EMPTY);
+  const isReadyAtom = loadable(listsStorageAtom);
   function useListState() {
     return useAtom(defaultStateAtom);
   }
   function useListStateReady() {
-    return useAtomValue(isReadyAtom);
+    const value = useAtomValue(isReadyAtom);
+    return value.state === "hasData" && value.data !== EMPTY;
   }
   return {
     listsAtom: defaultStateAtom,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pancakeswap/token-lists",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -11,18 +11,19 @@
   },
   "peerDependencies": {
     "@reduxjs/toolkit": "^1.9.1",
+    "jotai": "^2.4.3",
     "localforage": "^1.10.0",
-    "jotai": "^2.2.1",
     "react": "^18.2.0"
   },
   "devDependencies": {
-    "@types/react": "^18.0.17",
-    "localforage": "^1.10.0",
-    "jotai": "^2.2.1",
     "@reduxjs/toolkit": "^1.9.1",
+    "@types/react": "^18.2.21",
+    "jotai": "^2.4.3",
+    "localforage": "^1.10.0",
     "react": "^18.2.0",
     "tsup": "^6.7.0",
-    "@pancakeswap/utils": "2.0.1"
+    "vitest": "^0.34.4",
+    "@pancakeswap/utils": "5.0.6"
   },
   "exports": {
     ".": {
@@ -53,6 +54,7 @@
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
+    "test": "vitest --run",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
   }
 }

package/react/index.test.ts

@@ -0,0 +1,21 @@
+import { expect, test } from 'vitest'
+import * as exports from './index'
+
+test('exports', () => {
+  expect(Object.keys(exports)).toMatchInlineSnapshot(`
+    [
+      "NEW_LIST_STATE",
+      "createTokenListReducer",
+      "fetchTokenList",
+      "addList",
+      "removeList",
+      "enableList",
+      "disableList",
+      "acceptListUpdate",
+      "rejectVersionUpdate",
+      "updateListVersion",
+      "createListsAtom",
+      "useFetchListCallback",
+    ]
+  `)
+})

package/react/lists.ts

@@ -1,16 +1,16 @@
 import { atom, useAtom, useAtomValue } from 'jotai'
-import { atomWithStorage } from 'jotai/utils'
+import { atomWithStorage, loadable } from 'jotai/utils'
+import { type AsyncStorage } from 'jotai/vanilla/utils/atomWithStorage'
 import localForage from 'localforage'
 import { ListsState } from './reducer'
 
 // eslint-disable-next-line @typescript-eslint/no-empty-function
 function noop() {}
-const noopStorage = {
-  getItem: noop,
-  setItem: noop,
-  removeItem: noop,
-  keys: [],
-  getAllKeys: noop,
+
+const noopStorage: AsyncStorage<any> = {
+  getItem: () => Promise.resolve(noop()),
+  setItem: () => Promise.resolve(noop()),
+  removeItem: () => Promise.resolve(noop()),
 }
 
 // eslint-disable-next-line symbol-description
@@ -21,14 +21,13 @@ export const createListsAtom = (storeName: string, reducer: any, initialState: a
    * Persist you redux state using IndexedDB
    * @param {string} dbName - IndexedDB database name
    */
-  function IndexedDBStorage(dbName: string) {
+  function IndexedDBStorage<Value>(dbName: string): AsyncStorage<Value> {
     if (typeof window !== 'undefined') {
       const db = localForage.createInstance({
         name: dbName,
         storeName,
       })
       return {
-        db,
         getItem: async (key: string) => {
           const value = await db.getItem(key)
           if (value) {
@@ -36,10 +35,9 @@ export const createListsAtom = (storeName: string, reducer: any, initialState: a
           }
           return initialState
         },
-        setItem: (k: string, v: any) => {
+        setItem: async (k: string, v: any) => {
           if (v === EMPTY) return
-          // eslint-disable-next-line consistent-return
-          return db.setItem(k, v)
+          await db.setItem(k, v)
         },
         removeItem: db.removeItem,
       }
@@ -47,34 +45,30 @@ export const createListsAtom = (storeName: string, reducer: any, initialState: a
     return noopStorage
   }
 
-  const listsStorageAtom = atomWithStorage<ListsState | typeof EMPTY>(
-    'lists',
-    EMPTY,
-    // @ts-ignore
-    IndexedDBStorage('lists'),
-  )
+  const listsStorageAtom = atomWithStorage<ListsState | typeof EMPTY>('lists', EMPTY, IndexedDBStorage('lists'))
 
   const defaultStateAtom = atom<ListsState, any, void>(
     (get) => {
-      const got = get(listsStorageAtom)
-      if (got === EMPTY) {
-        return initialState
+      const value = get(loadable(listsStorageAtom))
+      if (value.state === 'hasData' && value.data !== EMPTY) {
+        return value.data
       }
-      return got
+      return initialState
     },
     async (get, set, action) => {
       set(listsStorageAtom, reducer(await get(defaultStateAtom), action))
     },
   )
 
-  const isReadyAtom = atom((get) => get(listsStorageAtom) !== EMPTY)
+  const isReadyAtom = loadable(listsStorageAtom)
 
   function useListState() {
     return useAtom(defaultStateAtom)
   }
 
   function useListStateReady() {
-    return useAtomValue(isReadyAtom)
+    const value = useAtomValue(isReadyAtom)
+    return value.state === 'hasData' && value.data !== EMPTY
   }
 
   return {

package/react/reducer.test.ts

@@ -1,11 +1,10 @@
 import { describe, it, expect, beforeEach } from 'vitest'
-import { Store } from 'redux'
-import { configureStore } from '@reduxjs/toolkit'
+import { configureStore, type EnhancedStore } from '@reduxjs/toolkit'
 
 import { fetchTokenList, acceptListUpdate, addList, removeList, enableList, updateListVersion } from './actions'
-import { ListsState, createTokenListReducer, NEW_LIST_STATE } from './reducer'
+import { ListsState, createTokenListReducer, NEW_LIST_STATE, type ListByUrlState } from './reducer'
 
-const DEFAULT_ACTIVE_LIST_URLS = []
+const DEFAULT_ACTIVE_LIST_URLS: string[] = []
 const DEFAULT_LIST_OF_LISTS = ['https://tokens.pancakeswap.finance/pancakeswap-extended.json']
 const STUB_TOKEN_LIST = {
   name: '',
@@ -14,7 +13,7 @@ const STUB_TOKEN_LIST = {
   tokens: [],
 }
 
-const UNSUPPORTED_LIST_URLS = []
+const UNSUPPORTED_LIST_URLS: string[] = []
 
 const reducer = createTokenListReducer(
   {
@@ -23,7 +22,7 @@ const reducer = createTokenListReducer(
       ...DEFAULT_LIST_OF_LISTS.concat(...UNSUPPORTED_LIST_URLS).reduce((memo, listUrl) => {
         memo[listUrl] = NEW_LIST_STATE
         return memo
-      }, {}),
+      }, {} as Record<string, ListByUrlState>),
     },
     activeListUrls: DEFAULT_ACTIVE_LIST_URLS,
   },
@@ -44,12 +43,24 @@ const MAJOR_UPDATED_STUB_LIST = {
   version: { ...STUB_TOKEN_LIST.version, major: STUB_TOKEN_LIST.version.major + 1 },
 }
 
-describe.skip('list reducer', () => {
-  let store: Store<ListsState>
+const resetStore = (preloadedState?: ListsState) => {
+  return configureStore({ reducer, preloadedState })
+}
+
+describe('list reducer', () => {
+  let store: EnhancedStore<ListsState> = resetStore()
 
   beforeEach(() => {
-    store = configureStore({
-      reducer,
+    store = resetStore({
+      byUrl: {
+        'fake-url': {
+          error: null,
+          current: STUB_TOKEN_LIST,
+          pendingUpdate: null,
+          loadingRequestId: null,
+        },
+      },
+      activeListUrls: undefined,
     })
   })
 
@@ -62,7 +73,7 @@ describe.skip('list reducer', () => {
             'fake-url': {
               error: null,
               loadingRequestId: 'request-id',
-              current: null,
+              current: STUB_TOKEN_LIST,
               pendingUpdate: null,
             },
           },
@@ -71,7 +82,7 @@ describe.skip('list reducer', () => {
       })
 
       it('does not clear current list', () => {
-        store = createStore(reducer, {
+        store = resetStore({
           byUrl: {
             'fake-url': {
               error: null,
@@ -200,6 +211,7 @@ describe.skip('list reducer', () => {
 
     describe('rejected', () => {
       it('no-op if not loading', () => {
+        store = resetStore({ byUrl: {}, activeListUrls: undefined })
         store.dispatch(fetchTokenList.rejected({ requestId: 'request-id', errorMessage: 'abcd', url: 'fake-url' }))
         expect(store.getState()).toEqual({
           byUrl: {},
@@ -208,7 +220,7 @@ describe.skip('list reducer', () => {
       })
 
       it('sets the error if loading', () => {
-        store = createStore(reducer, {
+        store = resetStore({
           byUrl: {
             'fake-url': {
               error: null,
@@ -237,9 +249,26 @@ describe.skip('list reducer', () => {
 
   describe('addList', () => {
     it('adds the list key to byUrl', () => {
+      store = resetStore({
+        byUrl: {
+          'fake-url': {
+            error: null,
+            current: STUB_TOKEN_LIST,
+            loadingRequestId: null,
+            pendingUpdate: null,
+          },
+        },
+        activeListUrls: undefined,
+      })
       store.dispatch(addList('list-id'))
       expect(store.getState()).toEqual({
         byUrl: {
+          'fake-url': {
+            error: null,
+            current: STUB_TOKEN_LIST,
+            loadingRequestId: null,
+            pendingUpdate: null,
+          },
           'list-id': {
             error: null,
             current: null,
@@ -251,7 +280,7 @@ describe.skip('list reducer', () => {
       })
     })
     it('no op for existing list', () => {
-      store = createStore(reducer, {
+      store = resetStore({
         byUrl: {
           'fake-url': {
             error: null,
@@ -279,7 +308,7 @@ describe.skip('list reducer', () => {
 
   describe('acceptListUpdate', () => {
     it('swaps pending update into current', () => {
-      store = createStore(reducer, {
+      store = resetStore({
         byUrl: {
           'fake-url': {
             error: null,
@@ -307,7 +336,7 @@ describe.skip('list reducer', () => {
 
   describe('removeList', () => {
     it('deletes the list key', () => {
-      store = createStore(reducer, {
+      store = resetStore({
         byUrl: {
           'fake-url': {
             error: null,
@@ -325,7 +354,7 @@ describe.skip('list reducer', () => {
       })
     })
     it('Removes from active lists if active list is removed', () => {
-      store = createStore(reducer, {
+      store = resetStore({
         byUrl: {
           'fake-url': {
             error: null,
@@ -346,7 +375,7 @@ describe.skip('list reducer', () => {
 
   describe('enableList', () => {
     it('enables a list url', () => {
-      store = createStore(reducer, {
+      store = resetStore({
         byUrl: {
           'fake-url': {
             error: null,
@@ -371,7 +400,7 @@ describe.skip('list reducer', () => {
       })
     })
     it('adds to url keys if not present already on enable', () => {
-      store = createStore(reducer, {
+      store = resetStore({
         byUrl: {
           'fake-url': {
             error: null,
@@ -402,7 +431,7 @@ describe.skip('list reducer', () => {
       })
     })
     it('enable works if list already added', () => {
-      store = createStore(reducer, {
+      store = resetStore({
         byUrl: {
           'fake-url': {
             error: null,
@@ -431,7 +460,7 @@ describe.skip('list reducer', () => {
   describe('updateVersion', () => {
     describe('never initialized', () => {
       beforeEach(() => {
-        store = createStore(reducer, {
+        store = resetStore({
           byUrl: {
             'https://unpkg.com/@uniswap/default-token-list@latest/uniswap-default.tokenlist.json': {
               error: null,
@@ -481,7 +510,7 @@ describe.skip('list reducer', () => {
     })
     describe('initialized with a different set of lists', () => {
       beforeEach(() => {
-        store = createStore(reducer, {
+        store = resetStore({
           byUrl: {
             'https://unpkg.com/@uniswap/default-token-list@latest/uniswap-default.tokenlist.json': {
               error: null,

package/react/reducer.ts

@@ -27,7 +27,7 @@ export interface ListsState {
   readonly activeListUrls: string[] | undefined
 }
 
-type ListByUrlState = ListsState['byUrl'][string]
+export type ListByUrlState = ListsState['byUrl'][string]
 
 export const NEW_LIST_STATE: ListByUrlState = {
   error: null,

package/src/index.test.ts

@@ -0,0 +1,14 @@
+import { expect, test } from 'vitest'
+import * as exports from './index'
+
+test('exports', () => {
+  expect(Object.keys(exports)).toMatchInlineSnapshot(`
+    [
+      "WrappedTokenInfo",
+      "deserializeToken",
+      "VersionUpgrade",
+      "getVersionUpgrade",
+      "createFilterToken",
+    ]
+  `)
+})