Clean up types (#1016)

* deprecate ConfigInterface; fix exported types

* deprecate SWRInfiniteConfigInterface and SWRInfiniteResponseInterface

* deprecate CacheInterface

* deprecate RevalidateOptionInterface and keyInterface

* deprecate revalidateType

* deprecate responseInterface

* reorder

* clean up internal types

Author: shuding

src/cache.ts

@@ -1,21 +1,21 @@
-import { CacheInterface, keyInterface, cacheListener } from './types'
+import { Cache as CacheType, Key, CacheListener } from './types'
 import hash from './libs/hash'
 
-export default class Cache implements CacheInterface {
+export default class Cache implements CacheType {
   private __cache: Map<string, any>
-  private __listeners: cacheListener[]
+  private __listeners: CacheListener[]
 
   constructor(initialData: any = {}) {
     this.__cache = new Map(Object.entries(initialData))
     this.__listeners = []
   }
 
-  get(key: keyInterface): any {
+  get(key: Key): any {
     const [_key] = this.serializeKey(key)
     return this.__cache.get(_key)
   }
 
-  set(key: keyInterface, value: any): any {
+  set(key: Key, value: any): any {
     const [_key] = this.serializeKey(key)
     this.__cache.set(_key, value)
     this.notify()
@@ -25,7 +25,7 @@ export default class Cache implements CacheInterface {
     return Array.from(this.__cache.keys())
   }
 
-  has(key: keyInterface) {
+  has(key: Key) {
     const [_key] = this.serializeKey(key)
     return this.__cache.has(_key)
   }
@@ -35,14 +35,14 @@ export default class Cache implements CacheInterface {
     this.notify()
   }
 
-  delete(key: keyInterface) {
+  delete(key: Key) {
     const [_key] = this.serializeKey(key)
     this.__cache.delete(_key)
     this.notify()
   }
 
   // TODO: introduce namespace for the cache
-  serializeKey(key: keyInterface): [string, any, string, string] {
+  serializeKey(key: Key): [string, any, string, string] {
     let args = null
     if (typeof key === 'function') {
       try {
@@ -68,7 +68,7 @@ export default class Cache implements CacheInterface {
     return [key, args, errorKey, isValidatingKey]
   }
 
-  subscribe(listener: cacheListener) {
+  subscribe(listener: CacheListener) {
     if (typeof listener !== 'function') {
       throw new Error('Expected the listener to be a function.')
     }

src/config.ts

@@ -1,9 +1,5 @@
 import { dequal } from 'dequal/lite'
-import {
-  ConfigInterface,
-  RevalidateOptionInterface,
-  revalidateType
-} from './types'
+import { SWRConfiguration, RevalidatorOptions, Revalidator } from './types'
 import Cache from './cache'
 import webPreset from './libs/web-preset'
 
@@ -14,9 +10,9 @@ const cache = new Cache()
 function onErrorRetry(
   _,
   __,
-  config: ConfigInterface,
-  revalidate: revalidateType,
-  opts: RevalidateOptionInterface
+  config: SWRConfiguration,
+  revalidate: Revalidator,
+  opts: RevalidatorOptions
 ): void {
   if (!config.isDocumentVisible()) {
     // if it's hidden, stop
@@ -47,7 +43,7 @@ const slowConnection =
   ['slow-2g', '2g'].indexOf(navigator['connection'].effectiveType) !== -1
 
 // config
-const defaultConfig: ConfigInterface = Object.assign(
+const defaultConfig: SWRConfiguration = Object.assign(
   {
     // events
     onLoadingSlow: () => {},

src/index.ts

@@ -1,17 +1,31 @@
-export * from './use-swr'
+// `useSWR` and related APIs
 import { default as useSWR } from './use-swr'
-export {
-  useSWRInfinite,
-  SWRInfiniteConfigInterface,
-  SWRInfiniteResponseInterface
-} from './use-swr-infinite'
+export default useSWR
+export * from './use-swr'
+
+// `useSWRInfinite`
+export { useSWRInfinite } from './use-swr-infinite'
+
+// Cache related, to be replaced by the new APIs
 export { cache } from './config'
+
+// Types
 export {
+  SWRConfiguration,
+  SWRInfiniteConfiguration,
+  SWRInfiniteResponse,
+  Revalidator,
+  RevalidatorOptions,
+  Key,
+  SWRResponse,
+  Cache,
+  // Legacy, for backwards compatibility
   ConfigInterface,
+  SWRInfiniteConfigInterface,
+  SWRInfiniteResponseInterface,
   revalidateType,
   RevalidateOptionInterface,
   keyInterface,
   responseInterface,
   CacheInterface
 } from './types'
-export default useSWR

src/swr-config-context.ts

@@ -1,8 +1,8 @@
 import { createContext } from 'react'
 
-import { ConfigInterface } from './types'
+import { SWRConfiguration } from './types'
 
-const SWRConfigContext = createContext<Partial<ConfigInterface>>({})
+const SWRConfigContext = createContext<SWRConfiguration>({})
 SWRConfigContext.displayName = 'SWRConfigContext'
 
 export default SWRConfigContext