Fix types generate (#1266)

* fix: types generation

* replace resolved swr in tests

* avoid emit swr types in subpath module

* use paths for type imports

* revert few changes

Author: huozhi

.eslintrc

@@ -8,7 +8,7 @@
       "experimentalObjectRestSpread": true
     },
     "allowImportExportEverywhere": true,
-    "project": ["**/tsconfig.json", "tsconfig.test.json"]
+    "project": ["**/tsconfig.json"]
   },
   "plugins": ["@typescript-eslint", "react-hooks"],
   "extends": [

immutable/index.ts

@@ -1,8 +1,5 @@
-// @ts-ignore
-import useSWR from 'swr'
-
+import useSWR, { Middleware, SWRHook } from 'swr'
 import { withMiddleware } from '../src/utils/with-middleware'
-import { Middleware, SWRHook } from '../src/types'
 
 export const immutable: Middleware = useSWRNext => (key, fetcher, config) => {
   // Always override all revalidate options.

immutable/tsconfig.json

@@ -1,9 +1,8 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "./dist",
     "rootDir": "..",
+    "outDir": "./dist"
   },
-  "include": [".", "../src"],
-  "exclude": ["./dist"]
+  "include": ["./*.ts"]
 }

infinite/index.ts

@@ -2,11 +2,8 @@
 // hook where `key` and return type are not like the normal `useSWR` types.
 
 import { useRef, useState, useCallback } from 'react'
+import useSWR, { SWRConfig } from 'swr'
 
-// @ts-ignore
-import useSWR from 'swr'
-
-import defaultConfig from '../src/utils/config'
 import { useIsomorphicLayoutEffect } from '../src/utils/env'
 import { serialize } from '../src/utils/serialize'
 import { isUndefined, UNDEFINED } from '../src/utils/helper'
@@ -20,12 +17,12 @@ import {
   SWRInfiniteResponse,
   MutatorCallback,
   Middleware
-} from '../src/types'
+} from 'swr'
 
 export const infinite = ((<Data, Error>(useSWRNext: SWRHook) => (
   getKey: KeyLoader<Data>,
   fn: Fetcher<Data> | null,
-  config: typeof defaultConfig & SWRInfiniteConfiguration<Data, Error>
+  config: typeof SWRConfig.default & SWRInfiniteConfiguration<Data, Error>
 ): SWRInfiniteResponse<Data, Error> => {
   const {
     cache,

infinite/tsconfig.json

@@ -1,9 +1,8 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "./dist",
     "rootDir": "..",
+    "outDir": "./dist"
   },
-  "include": [".", "../src"],
-  "exclude": ["./dist"]
+  "include": ["./*.ts"]
 }

jest.config.js

@@ -9,7 +9,7 @@ module.exports = {
   },
   globals: {
     'ts-jest': {
-      tsconfig: 'tsconfig.test.json'
+      tsconfig: 'test/tsconfig.json'
     }
   }
 }

package.json

@@ -34,6 +34,7 @@
   "homepage": "https://swr.vercel.app",
   "license": "MIT",
   "scripts": {
+    "clean": "rm -rf dist infinite/dist immutable/dist",
     "build": "yarn build:core && yarn build:infinite && yarn build:immutable",
     "watch": "concurrently \"yarn watch:core\" \"yarn watch:infinite\" \"yarn watch:immutable\"",
     "watch:core": "bunchee src/index.ts --watch",
@@ -42,7 +43,7 @@
     "build:core": "bunchee src/index.ts -m --no-sourcemap",
     "build:infinite": "bunchee index.ts --cwd infinite -m --no-sourcemap",
     "build:immutable": "bunchee index.ts --cwd immutable -m --no-sourcemap",
-    "prepublishOnly": "rm -rf dist infinite/dist immutable/dist && yarn build",
+    "prepublishOnly": "yarn clean && yarn build",
     "types:check": "tsc --noEmit",
     "format": "prettier --write \"{src,infinite,immutable,test,examples}/**/*.{ts,tsx}\"",
     "lint": "eslint \"{src,infinite,immutable,test,examples}/**/*.{ts,tsx}\"",

src/index.ts

@@ -16,6 +16,9 @@ export {
   KeyLoader,
   SWRResponse,
   Cache,
+  SWRHook,
+  Fetcher,
+  MutatorCallback,
   Middleware,
   // Legacy, for backwards compatibility
   ConfigInterface,

src/types.ts

@@ -47,6 +47,11 @@ export interface Configuration<
 
   compare: (a: Data | undefined, b: Data | undefined) => boolean
 
+  isOnline: () => boolean
+  isDocumentVisible: () => boolean
+  registerOnFocus: (cb: () => void) => void
+  registerOnReconnect: (cb: () => void) => void
+
   /**
    * @deprecated `revalidateOnMount` will be removed. Please considering using the `revalidateWhenStale` option.
    */
@@ -65,13 +70,6 @@ export type SWRHook = <Data = any, Error = any>(
       ]
 ) => SWRResponse<Data, Error>
 
-export interface Preset {
-  isOnline: () => boolean
-  isDocumentVisible: () => boolean
-  registerOnFocus?: (cb: () => void) => void
-  registerOnReconnect?: (cb: () => void) => void
-}
-
 // Middlewares guarantee that a SWRHook receives a key, fetcher, and config as the argument
 type SWRHookWithMiddleware = <Data = any, Error = any>(
   key: Key,

src/use-swr.ts

@@ -18,6 +18,7 @@ import {
   SWRResponse,
   RevalidatorOptions,
   Updater,
+  Configuration,
   SWRConfiguration,
   Cache,
   ScopedMutator,
@@ -681,7 +682,7 @@ export function useSWRHandler<Data = any, Error = any>(
 export const SWRConfig = Object.defineProperty(ConfigProvider, 'default', {
   value: defaultConfig
 }) as typeof ConfigProvider & {
-  default: SWRConfiguration
+  default: Configuration
 }
 
 export const mutate = internalMutate.bind(

src/utils/config.ts

@@ -36,7 +36,7 @@ function onErrorRetry(
 }
 
 // Default config
-const defaultConfig = {
+const defaultConfig: Configuration = {
   // events
   onLoadingSlow: noop,
   onSuccess: noop,

test/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "..",
+    "strict": false
+  },
+  "include": [
+    ".", 
+    "../jest-setup.ts"
+  ]
+}

test/use-swr-cache.test.tsx

@@ -1,6 +1,6 @@
 import { act, fireEvent, render, screen } from '@testing-library/react'
 import React, { useState } from 'react'
-import useSWR, { createCache, SWRConfig } from '../src'
+import useSWR, { createCache, SWRConfig } from 'swr'
 import { sleep, createKey } from './utils'
 
 describe('useSWR - cache', () => {

test/use-swr-concurrent-rendering.test.tsx

@@ -20,7 +20,7 @@ describe('useSWR - concurrent rendering', () => {
     React = require('react')
     ReactDOM = require('react-dom')
     act = require('react-dom/test-utils').act
-    useSWR = require('../src').default
+    useSWR = require('swr').default
   })
 
   it('should fetch data in concurrent rendering', async () => {

test/use-swr-config-callbacks.test.tsx

@@ -1,6 +1,6 @@
 import { act, render, screen, fireEvent } from '@testing-library/react'
 import React from 'react'
-import useSWR from '../src'
+import useSWR from 'swr'
 import { sleep, createResponse } from './utils'
 
 describe('useSWR - config callbacks', () => {

test/use-swr-configs.test.tsx

@@ -1,6 +1,6 @@
 import { act, render, screen, fireEvent } from '@testing-library/react'
 import React, { useEffect, useState } from 'react'
-import useSWR, { mutate, SWRConfig } from '../src'
+import useSWR, { mutate, SWRConfig } from 'swr'
 import { sleep } from './utils'
 
 describe('useSWR - configs', () => {

test/use-swr-context-config.test.tsx

@@ -1,6 +1,6 @@
 import { act, render, screen } from '@testing-library/react'
 import React from 'react'
-import useSWR, { mutate } from '../src'
+import useSWR, { mutate } from 'swr'
 import { createResponse } from './utils'
 
 describe('useSWR - context configs', () => {

test/use-swr-error.test.tsx

@@ -1,6 +1,6 @@
 import { act, fireEvent, render, screen } from '@testing-library/react'
 import React, { useEffect, useState } from 'react'
-import useSWR, { mutate } from '../src'
+import useSWR, { mutate } from 'swr'
 import { sleep, createResponse } from './utils'
 
 describe('useSWR - error', () => {

test/use-swr-focus.test.tsx

@@ -1,6 +1,6 @@
 import { act, fireEvent, render, screen } from '@testing-library/react'
 import React, { useState } from 'react'
-import useSWR from '../src'
+import useSWR from 'swr'
 import { sleep } from './utils'
 
 const waitForNextTick = () => act(() => sleep(1))

test/use-swr-immutable.test.tsx

@@ -1,7 +1,7 @@
 import { render, screen, act, fireEvent } from '@testing-library/react'
 import React, { useState } from 'react'
-import useSWR from '../src'
-import useSWRImmutable from '../immutable'
+import useSWR from 'swr'
+import useSWRImmutable from 'swr/immutable'
 import { sleep, createKey } from './utils'
 
 const waitForNextTick = () => act(() => sleep(1))

test/use-swr-infinite.test.tsx

@@ -1,7 +1,7 @@
 import React, { useEffect, useState } from 'react'
 import { render, fireEvent, act, screen } from '@testing-library/react'
-import { mutate } from '../src'
-import useSWRInfinite from '../infinite'
+import { mutate } from 'swr'
+import useSWRInfinite from 'swr/infinite'
 import { sleep, createResponse } from './utils'
 
 describe('useSWRInfinite', () => {

test/use-swr-integration.test.tsx

@@ -1,6 +1,6 @@
 import { act, render, screen, fireEvent } from '@testing-library/react'
 import React, { useState, useEffect } from 'react'
-import useSWR from '../src'
+import useSWR from 'swr'
 import { createResponse, sleep } from './utils'
 
 const waitForNextTick = () => act(() => sleep(1))

test/use-swr-key.test.tsx

@@ -1,6 +1,6 @@
 import { act, fireEvent, render, screen } from '@testing-library/react'
 import React, { useState, useEffect } from 'react'
-import useSWR from '../src'
+import useSWR from 'swr'
 import { createResponse, sleep } from './utils'
 
 describe('useSWR - key', () => {

test/use-swr-loading.test.tsx

@@ -1,6 +1,6 @@
 import { act, render, screen } from '@testing-library/react'
 import React from 'react'
-import useSWR from '../src'
+import useSWR from 'swr'
 import { createResponse, sleep } from './utils'
 
 describe('useSWR - loading', () => {

test/use-swr-local-mutation.test.tsx

@@ -1,6 +1,6 @@
 import { act, render, screen, fireEvent } from '@testing-library/react'
 import React, { useEffect, useState } from 'react'
-import useSWR, { mutate, createCache, SWRConfig } from '../src'
+import useSWR, { mutate, createCache, SWRConfig } from 'swr'
 import { serialize } from '../src/utils/serialize'
 import { createResponse, sleep } from './utils'
 

test/use-swr-middlewares.test.tsx

@@ -1,6 +1,6 @@
 import { act, render, screen } from '@testing-library/react'
 import React, { useState, useEffect, useRef } from 'react'
-import useSWR, { Middleware, SWRConfig } from '../src'
+import useSWR, { Middleware, SWRConfig } from 'swr'
 import { createResponse, sleep, createKey } from './utils'
 
 describe('useSWR - middlewares', () => {

test/use-swr-offline.test.tsx

@@ -1,6 +1,6 @@
 import { act, fireEvent, render, screen } from '@testing-library/react'
 import React from 'react'
-import useSWR from '../src'
+import useSWR from 'swr'
 import { sleep } from './utils'
 
 const waitForNextTick = () => act(() => sleep(1))

test/use-swr-refresh.test.tsx

@@ -1,6 +1,6 @@
 import { act, fireEvent, render, screen } from '@testing-library/react'
 import React, { useState } from 'react'
-import useSWR, { createCache, SWRConfig } from '../src'
+import useSWR, { createCache, SWRConfig } from 'swr'
 import { sleep } from './utils'
 
 // This has to be an async function to wait a microtask to flush updates

test/use-swr-revalidate.test.tsx

@@ -1,6 +1,6 @@
 import { act, fireEvent, render, screen } from '@testing-library/react'
 import React from 'react'
-import useSWR from '../src'
+import useSWR from 'swr'
 import { createResponse, sleep } from './utils'
 
 const waitForNextTick = () => act(() => sleep(1))

test/use-swr-suspense.test.tsx

@@ -1,6 +1,6 @@
 import { act, fireEvent, render, screen } from '@testing-library/react'
 import React, { ReactNode, Suspense, useEffect, useState } from 'react'
-import useSWR, { mutate } from '../src'
+import useSWR, { mutate } from 'swr'
 import { createResponse, sleep } from './utils'
 
 class ErrorBoundary extends React.Component<{ fallback: ReactNode }> {

tsconfig.json

@@ -15,6 +15,12 @@
     "rootDir": "src",
     "strict": true,
     "target": "es5",
+    "baseUrl": ".",
+    "paths": {
+      "swr": ["./src/index.ts"],
+      "swr/infinite": ["./infinite/index.ts"],
+      "swr/immutable": ["./immutable/index.ts"]
+    },
     "typeRoots": ["./src/types", "./node_modules/@types"]
   },
   "include": ["src"],