apply review change and type useSWRInfinite

Author: promer94

immutable/index.ts

@@ -1,4 +1,4 @@
-import useSWR, { Middleware, SWRHook } from 'swr'
+import useSWR, { Middleware } from 'swr'
 import { withMiddleware } from '../src/utils/with-middleware'
 
 export const immutable: Middleware = useSWRNext => (key, fetcher, config) => {
@@ -9,4 +9,4 @@ export const immutable: Middleware = useSWRNext => (key, fetcher, config) => {
   return useSWRNext(key, fetcher, config)
 }
 
-export default withMiddleware(useSWR as SWRHook, immutable)
+export default withMiddleware(useSWR, immutable)

infinite/index.ts

@@ -8,7 +8,9 @@ import useSWR, {
   Fetcher,
   SWRHook,
   MutatorCallback,
-  Middleware
+  Middleware,
+  ValueKey,
+  Result
 } from 'swr'
 import { useIsomorphicLayoutEffect } from '../src/utils/env'
 import { serialize } from '../src/utils/serialize'
@@ -18,18 +20,20 @@ import { SWRInfiniteConfiguration, SWRInfiniteResponse } from './types'
 
 const INFINITE_PREFIX = '$inf$'
 
-const getFirstPageKey = (getKey: KeyLoader<any>) => {
+const getFirstPageKey = (getKey: KeyLoader) => {
   return serialize(getKey ? getKey(0, null) : null)[0]
 }
 
-export const unstable_serialize = (getKey: KeyLoader<any>) => {
+export const unstable_serialize = (getKey: KeyLoader) => {
   return INFINITE_PREFIX + getFirstPageKey(getKey)
 }
 
-export const infinite = ((<Data, Error>(useSWRNext: SWRHook) => (
-  getKey: KeyLoader<Data>,
+export const infinite = ((<Data, Error, Args extends ValueKey>(
+  useSWRNext: SWRHook
+) => (
+  getKey: KeyLoader<Args>,
   fn: Fetcher<Data> | null,
-  config: typeof SWRConfig.default & SWRInfiniteConfiguration<Data, Error>
+  config: typeof SWRConfig.default & SWRInfiniteConfiguration<Data, Error, Args>
 ): SWRInfiniteResponse<Data, Error> => {
   const rerender = useState({})[1]
   const didMountRef = useRef<boolean>(false)
@@ -246,20 +250,39 @@ export const infinite = ((<Data, Error>(useSWRNext: SWRHook) => (
   } as SWRInfiniteResponse<Data, Error>
 }) as unknown) as Middleware
 
-type SWRInfiniteHook = <Data = any, Error = any>(
-  ...args:
-    | readonly [KeyLoader<Data>]
-    | readonly [KeyLoader<Data>, Fetcher<Data> | null]
-    | readonly [
-        KeyLoader<Data>,
-        SWRInfiniteConfiguration<Data, Error> | undefined
-      ]
-    | readonly [
-        KeyLoader<Data>,
-        Fetcher<Data> | null,
-        SWRInfiniteConfiguration<Data, Error> | undefined
-      ]
-) => SWRInfiniteResponse<Data, Error>
+export type InfiniteFetcher<
+  Args extends ValueKey = ValueKey,
+  Data = unknown
+> = Args extends (readonly [...infer K])
+  ? ((...args: [...K]) => Result<Data>)
+  : Args extends (string | null)
+  ? Args extends (Record<any, any> | null)
+    ? never
+    : (...args: [string]) => Result<Data>
+  : Args extends (infer T)
+  ? (...args: [T]) => Result<Data>
+  : never
+
+interface SWRInfiniteHook {
+  <Data = any, Error = any, Args extends ValueKey = ValueKey>(
+    getKey: KeyLoader<Args>
+  ): SWRInfiniteResponse<Data, Error>
+  <Data = any, Error = any, Args extends ValueKey = ValueKey>(
+    getKey: KeyLoader<Args>,
+    fn: InfiniteFetcher<Args, Data> | null
+  ): SWRInfiniteResponse<Data, Error>
+  <Data = any, Error = any, Args extends ValueKey = ValueKey>(
+    getKey: KeyLoader<Args>,
+    config: SWRInfiniteConfiguration<Data, Error, Args> | undefined
+  ): SWRInfiniteResponse<Data, Error>
+  <Data = any, Error = any, Args extends ValueKey = ValueKey>(
+    ...args: [
+      KeyLoader<Args>,
+      InfiniteFetcher<Args, Data> | null,
+      SWRInfiniteConfiguration<Data, Error, Args> | undefined
+    ]
+  ): SWRInfiniteResponse<Data, Error>
+}
 
 export default withMiddleware(useSWR, infinite) as SWRInfiniteHook
 export { SWRInfiniteConfiguration, SWRInfiniteResponse }

infinite/types.ts

@@ -1,9 +1,10 @@
-import { SWRConfiguration, Fetcher, SWRResponse } from 'swr'
+import { SWRConfiguration, Fetcher, SWRResponse, ValueKey } from 'swr'
 
 export type SWRInfiniteConfiguration<
   Data = any,
-  Error = any
-> = SWRConfiguration<Data[], Error, Fetcher<Data[]>> & {
+  Error = any,
+  Args extends ValueKey = ValueKey
+> = SWRConfiguration<Data[], Error, Args, Fetcher<Data[], Args>> & {
   initialSize?: number
   revalidateAll?: boolean
   persistSize?: boolean

package.json

@@ -46,11 +46,7 @@
     "build:immutable": "bunchee index.ts --cwd immutable -m --no-sourcemap",
     "prepublishOnly": "yarn clean && yarn build",
     "publish-beta": "yarn publish --tag beta",
-    "types:check": "yarn types:check:core && yarn types:check:infinite && yarn types:check:immutable && yarn types:check:fetcher",
-    "types:check:core": "tsc --noEmit",
-    "types:check:infinite": "cd infinite && tsc --noEmit",
-    "types:check:immutable": "cd immutable && tsc --noEmit",
-    "types:check:fetcher": "cd test-type && tsc --noEmit",
+    "types:check": "tsc --noEmit",
     "format": "prettier --write ./**/*.{ts,tsx}",
     "lint": "eslint . --ext .ts,.tsx",
     "lint:fix": "yarn lint --fix",

src/types.ts

@@ -143,9 +143,9 @@ export interface SWRHook {
 }
 
 // Middlewares guarantee that a SWRHook receives a key, fetcher, and config as the argument
-type SWRHookWithMiddleware = <Data = any, Error = any>(
-  key: Key,
-  fetcher: Fetcher<Data, Key> | null,
+type SWRHookWithMiddleware = <Data = any, Error = any, Args extends Key = Key>(
+  key: Args,
+  fetcher: Fetcher<Data, Args> | null,
   config: SWRConfiguration<Data, Error>
 ) => SWRResponse<Data, Error>
 
@@ -216,8 +216,8 @@ export interface SWRResponse<Data, Error> {
   isValidating: boolean
 }
 
-export type KeyLoader<Data = any> =
-  | ((index: number, previousPageData: Data | null) => ValueKey)
+export type KeyLoader<Args extends ValueKey = ValueKey> =
+  | ((index: number, previousPageData: any | null) => Args)
   | null
 
 export interface RevalidatorOptions {

test-type/fetcher.ts

@@ -1,15 +1,17 @@
 import useSWR from 'swr'
+import useSWRInfinite from 'swr/infinite'
+
 type ExpectType = <T>(value: T) => void
 const expectType: ExpectType = () => {}
 
-const cond: () => boolean = () => true
+const truthy: () => boolean = () => true
 
 export function useString() {
   useSWR('/api/user', key => {
     expectType<string>(key)
     return key
   })
-  useSWR(cond() ? '/api/user' : null, key => {
+  useSWR(truthy() ? '/api/user' : null, key => {
     expectType<string>(key)
     return key
   })
@@ -20,7 +22,7 @@ export function useRecord() {
     expectType<{ a: string; b: { c: string; d: number } }>(key)
     return key
   })
-  useSWR(cond() ? { a: '1', b: { c: '3', d: 2 } } : null, key => {
+  useSWR(truthy() ? { a: '1', b: { c: '3', d: 2 } } : null, key => {
     expectType<{ a: string; b: { c: string; d: number } }>(key)
     return key
   })
@@ -32,7 +34,7 @@ export function useTuple() {
     return keys
   })
   useSWR(
-    cond() ? [{ a: '1', b: { c: '3' } }, [1231, '888']] : null,
+    truthy() ? [{ a: '1', b: { c: '3' } }, [1231, '888']] : null,
     (...keys) => {
       expectType<[{ a: string; b: { c: string } }, (string | number)[]]>(keys)
       return keys
@@ -56,7 +58,7 @@ export function useReadonlyTuple() {
     return keys
   })
   useSWR(
-    cond() ? ([{ a: '1', b: { c: '3' } }, [1231, '888']] as const) : null,
+    truthy() ? ([{ a: '1', b: { c: '3' } }, [1231, '888']] as const) : null,
     (...keys) => {
       expectType<
         [
@@ -83,7 +85,27 @@ export function useReturnString() {
     }
   )
   useSWR(
-    () => (cond() ? '/api/user' : null),
+    () => (truthy() ? '/api/user' : null),
+    key => {
+      expectType<string>(key)
+      return key
+    }
+  )
+
+  useSWRInfinite(
+    (index, previousPageData: string) => {
+      return `${index}${previousPageData}`
+    },
+    key => {
+      expectType<string>(key)
+      return key
+    }
+  )
+
+  useSWRInfinite(
+    (index, previousPageData: string) => {
+      return truthy() ? `${index}${previousPageData}` : null
+    },
     key => {
       expectType<string>(key)
       return key
@@ -100,12 +122,37 @@ export function useReturnRecord() {
     }
   )
   useSWR(
-    () => (cond() ? { a: '1', b: { c: '3', d: 2 } } : null),
+    () => (truthy() ? { a: '1', b: { c: '3', d: 2 } } : null),
     key => {
       expectType<{ a: string; b: { c: string; d: number } }>(key)
       return key
     }
   )
+
+  useSWRInfinite(
+    index => ({
+      index,
+      endPoint: '/api'
+    }),
+    key => {
+      expectType<{ index: number; endPoint: string }>(key)
+      return [key]
+    }
+  )
+
+  useSWRInfinite(
+    index =>
+      truthy()
+        ? {
+            index,
+            endPoint: '/api'
+          }
+        : null,
+    key => {
+      expectType<{ index: number; endPoint: string }>(key)
+      return [key]
+    }
+  )
 }
 
 export function useReturnTuple() {
@@ -117,12 +164,29 @@ export function useReturnTuple() {
     }
   )
   useSWR(
-    () => (cond() ? [{ a: '1', b: { c: '3' } }, [1231, '888']] : null),
+    () => (truthy() ? [{ a: '1', b: { c: '3' } }, [1231, '888']] : null),
     (...keys) => {
       expectType<[{ a: string; b: { c: string } }, (string | number)[]]>(keys)
       return keys
     }
   )
+
+  useSWRInfinite(
+    index => [{ a: '1', b: { c: '3', d: index } }, [1231, '888']],
+    (...keys) => {
+      expectType<[{ a: string; b: { c: string } }, (string | number)[]]>(keys)
+      return keys[1]
+    }
+  )
+
+  useSWRInfinite(
+    index =>
+      truthy() ? [{ a: '1', b: { c: '3', d: index } }, [1231, '888']] : null,
+    (...keys) => {
+      expectType<[{ a: string; b: { c: string } }, (string | number)[]]>(keys)
+      return keys[1]
+    }
+  )
 }
 
 export function useReturnReadonlyTuple() {
@@ -145,7 +209,7 @@ export function useReturnReadonlyTuple() {
   )
   useSWR(
     () =>
-      cond() ? ([{ a: '1', b: { c: '3' } }, [1231, '888']] as const) : null,
+      truthy() ? ([{ a: '1', b: { c: '3' } }, [1231, '888']] as const) : null,
     (...keys) => {
       expectType<
         [
@@ -161,4 +225,40 @@ export function useReturnReadonlyTuple() {
       return keys
     }
   )
+
+  useSWRInfinite(
+    () => [{ a: '1', b: { c: '3' } }, [1231, '888']] as const,
+    (...keys) => {
+      expectType<
+        [
+          {
+            readonly a: '1'
+            readonly b: {
+              readonly c: '3'
+            }
+          },
+          readonly [1231, '888']
+        ]
+      >(keys)
+      return keys
+    }
+  )
+  useSWRInfinite(
+    () =>
+      truthy() ? ([{ a: '1', b: { c: '3' } }, [1231, '888']] as const) : null,
+    (...keys) => {
+      expectType<
+        [
+          {
+            readonly a: '1'
+            readonly b: {
+              readonly c: '3'
+            }
+          },
+          readonly [1231, '888']
+        ]
+      >(keys)
+      return keys[1]
+    }
+  )
 }

tsconfig.json

@@ -27,7 +27,8 @@
   "include": [
     "src", 
     "immutable", 
-    "infinite"
+    "infinite",
+    "test-type"
   ],
   "exclude": [
     "./**/dist",