feat: Improve global suspense-enabled data type (#4126)

* feat: add SWRGlobalConfig interface for suspense-enabled typing

* examples: add global suspense-enabled example

Author: oosawy

examples/suspense-global/README.md

@@ -0,0 +1,30 @@
+# Basic
+
+## One-Click Deploy
+
+Deploy your own SWR project with Vercel.
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?s=https://github.com/vercel/swr/tree/main/examples/suspense)
+
+## How to Use
+
+Download the example:
+
+```bash
+curl https://codeload.github.com/vercel/swr/tar.gz/main | tar -xz --strip=2 swr-main/examples/suspense
+cd suspense
+```
+
+Install it and run:
+
+```bash
+yarn
+yarn dev
+# or
+npm install
+npm run dev
+```
+
+## The Idea behind the Example
+
+Show how to use the SWR suspense option with React suspense.

examples/suspense-global/components/error-handling.ts

@@ -0,0 +1,17 @@
+import React from 'react'
+
+export default class ErrorBoundary extends React.Component<any> {
+  state = { hasError: false, error: null }
+  static getDerivedStateFromError(error: any) {
+    return {
+      hasError: true,
+      error
+    }
+  }
+  render() {
+    if (this.state.hasError) {
+      return this.props.fallback
+    }
+    return this.props.children
+  }
+}

examples/suspense-global/global-swr-config.tsx

@@ -0,0 +1,24 @@
+'use client'
+
+import { SWRConfig } from 'swr'
+
+import fetcher from './libs/fetch'
+
+declare module 'swr' {
+  interface SWRGlobalConfig {
+    suspense: true
+  }
+}
+
+export function GlobalSWRConfig({ children }: { children: React.ReactNode }) {
+  return (
+    <SWRConfig
+      value={{
+        fetcher,
+        suspense: true
+      }}
+    >
+      {children}
+    </SWRConfig>
+  )
+}

examples/suspense-global/libs/fetch.ts

@@ -0,0 +1,8 @@
+export default async function fetcher(...args: [any]) {
+  const res = await fetch(...args)
+  if (!res.ok) {
+    throw new Error('An error occurred while fetching the data.')
+  } else {
+    return res.json()
+  }
+}

examples/suspense-global/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.

examples/suspense-global/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "suspense-global",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "next": "latest",
+    "react": "latest",
+    "react-dom": "latest",
+    "swr": "latest"
+  },
+  "scripts": {
+    "dev": "next",
+    "start": "next start",
+    "build": "next build"
+  }
+}

examples/suspense-global/pages/[user]/[repo].tsx

@@ -0,0 +1,30 @@
+import dynamic from 'next/dynamic'
+import Link from 'next/link'
+import { Suspense } from 'react'
+import ErrorHandling from '../../components/error-handling'
+import { useRouter } from 'next/router'
+
+const Detail = dynamic(() => import('./detail'), {
+  ssr: false
+})
+
+export default function Repo() {
+  const router = useRouter()
+  if (!router.isReady) return null
+  const { user, repo } = router.query
+  const id = `${user}/${repo}`
+
+  return (
+    <div style={{ textAlign: 'center' }}>
+      <h1>{id}</h1>
+      <Suspense fallback={<div>loading...</div>}>
+        <ErrorHandling fallback={<div>oooops!</div>}>
+          <Detail id={id}></Detail>
+        </ErrorHandling>
+      </Suspense>
+      <br />
+      <br />
+      <Link href="/">Back</Link>
+    </div>
+  )
+}

examples/suspense-global/pages/[user]/detail.tsx

@@ -0,0 +1,20 @@
+import useSWR from 'swr'
+import { RepoData } from '../api/data'
+
+const Detail = ({ id }: { id: string }) => {
+  const { data } = useSWR<RepoData>('/api/data?id=' + id)
+
+  return (
+    <>
+      {data ? (
+        <div>
+          <p>forks: {data.forks_count}</p>
+          <p>stars: {data.stargazers_count}</p>
+          <p>watchers: {data.watchers}</p>
+        </div>
+      ) : null}
+    </>
+  )
+}
+
+export default Detail

examples/suspense-global/pages/_app.tsx

@@ -0,0 +1,10 @@
+import type { AppProps } from 'next/app'
+import { GlobalSWRConfig } from 'global-swr-config'
+
+export default function MyApp({ Component, pageProps }: AppProps) {
+  return (
+    <GlobalSWRConfig>
+      <Component {...pageProps} />
+    </GlobalSWRConfig>
+  )
+}

examples/suspense-global/pages/api/data.ts

@@ -0,0 +1,40 @@
+import { NextApiRequest, NextApiResponse } from 'next'
+
+const projects = [
+  'facebook/flipper',
+  'vuejs/vuepress',
+  'rust-lang/rust',
+  'vercel/next.js',
+  'emperor/clothes'
+] as const
+
+export type ProjectsData = typeof projects
+
+export interface RepoData {
+  forks_count: number
+  stargazers_count: number
+  watchers: number
+}
+
+export default function api(req: NextApiRequest, res: NextApiResponse) {
+  if (req.query.id) {
+    if (req.query.id === projects[4]) {
+      setTimeout(() => {
+        res.status(404).json({ msg: 'not found' })
+      })
+    } else {
+      // a slow endpoint for getting repo data
+      fetch(`https://api.github.com/repos/${req.query.id}`)
+        .then(res => res.json())
+        .then(data => {
+          setTimeout(() => {
+            res.json(data)
+          }, 2000)
+        })
+    }
+  } else {
+    setTimeout(() => {
+      res.json(projects)
+    }, 2000)
+  }
+}