Group streaming experimental apis (#33878)

Move undocumented `next/rsc` and `next/vitals` to `next/streaming`. In the future `next/streaming` can contain streaming SSR related (including react server components) APIs together.
vercel · Feb 2, 2022 · 5365f41 · 5365f41
1 parent 965d26e
commit 5365f41
Show file tree

Hide file tree

Showing 14 changed files with 15 additions and 18 deletions.
diff --git a/packages/next/client/index.tsx b/packages/next/client/index.tsx
@@ -33,8 +33,11 @@ import measureWebVitals from './performance-relayer'
 import { RouteAnnouncer } from './route-announcer'
 import { createRouter, makePublicRouterInstance } from './router'
 import { getProperError } from '../lib/is-error'
-import { flushBufferedVitalsMetrics, trackWebVitalMetric } from './vitals'
-import { RefreshContext } from './rsc/refresh'
+import {
+  flushBufferedVitalsMetrics,
+  trackWebVitalMetric,
+} from './streaming/vitals'
+import { RefreshContext } from './streaming/refresh'
 
 /// <reference types="react-dom/experimental" />
 

diff --git a/packages/next/client/rsc/index.ts b/packages/next/client/rsc/index.ts
diff --git a/packages/next/client/streaming/index.ts b/packages/next/client/streaming/index.ts
@@ -0,0 +1,2 @@
+export { useRefreshRoot as unstable_useRefreshRoot } from './refresh'
+export { useWebVitalsReport as unstable_useWebVitalsReport } from './vitals'
diff --git a/packages/next/client/rsc/refresh.ts → packages/next/client/streaming/refresh.ts b/packages/next/client/rsc/refresh.ts → packages/next/client/streaming/refresh.ts
diff --git a/packages/next/client/vitals.ts → packages/next/client/streaming/vitals.ts b/packages/next/client/vitals.ts → packages/next/client/streaming/vitals.ts
@@ -1,5 +1,5 @@
 import { useEffect, useRef } from 'react'
-import { NextWebVitalsMetric } from '../pages/_app'
+import { NextWebVitalsMetric } from '../../pages/_app'
 
 type ReportWebVitalsCallback = (webVitals: NextWebVitalsMetric) => any
 export const webVitalsCallbacks = new Set<ReportWebVitalsCallback>()

diff --git a/packages/next/package.json b/packages/next/package.json
@@ -44,10 +44,8 @@
     "jest.d.ts",
     "amp.js",
     "amp.d.ts",
-    "vitals.js",
-    "vitals.d.ts",
-    "rsc.js",
-    "rsc.d.ts",
+    "streaming.js",
+    "streaming.d.ts",
     "index.d.ts",
     "types/index.d.ts",
     "types/global.d.ts",

diff --git a/packages/next/rsc.d.ts b/packages/next/rsc.d.ts
diff --git a/packages/next/rsc.js b/packages/next/rsc.js
diff --git a/packages/next/streaming.d.ts b/packages/next/streaming.d.ts
@@ -0,0 +1 @@
+export * from './dist/client/streaming'
diff --git a/packages/next/streaming.js b/packages/next/streaming.js
@@ -0,0 +1 @@
+module.exports = require('./dist/client/streaming')
diff --git a/packages/next/vitals.d.ts b/packages/next/vitals.d.ts
diff --git a/packages/next/vitals.js b/packages/next/vitals.js
diff --git a/test/integration/relay-analytics-disabled/pages/index.js b/test/integration/relay-analytics-disabled/pages/index.js
@@ -1,4 +1,4 @@
-import { getBufferedVitalsMetrics } from 'next/dist/client/vitals'
+import { getBufferedVitalsMetrics } from 'next/dist/client/streaming/vitals'
 
 if (typeof navigator !== 'undefined') {
   window.__BEACONS = window.__BEACONS || []

diff --git a/test/integration/relay-analytics/pages/index.js b/test/integration/relay-analytics/pages/index.js
@@ -1,6 +1,6 @@
 /* global localStorage */
-import { unstable_useWebVitalsReport } from 'next/vitals'
-import { getBufferedVitalsMetrics } from 'next/dist/client/vitals'
+import { unstable_useWebVitalsReport } from 'next/streaming'
+import { getBufferedVitalsMetrics } from 'next/dist/client/streaming/vitals'
 
 if (typeof navigator !== 'undefined') {
   window.__BEACONS = window.__BEACONS || []