-
Notifications
You must be signed in to change notification settings - Fork 26.8k
/
utils.ts
294 lines (258 loc) · 6.29 KB
/
utils.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
import { format, UrlObject, URLFormatOptions } from 'url'
import { ServerResponse, IncomingMessage } from 'http'
import { ComponentType } from 'react'
import { ParsedUrlQuery } from 'querystring'
import { ManifestItem } from '../server/render'
import { BaseRouter } from './router/router'
/**
* Types used by both next and next-server
*/
export type NextComponentType<
C extends BaseContext = NextPageContext,
IP = {},
P = {}
> = ComponentType<P> & {
getInitialProps?(context: C): IP | Promise<IP>
}
export type DocumentType = NextComponentType<
DocumentContext,
DocumentInitialProps,
DocumentProps
>
export type AppType = NextComponentType<
AppContextType,
AppInitialProps,
AppPropsType
>
export type Enhancer<C> = (Component: C) => C
export type ComponentsEnhancer =
| {
enhanceApp?: Enhancer<AppType>
enhanceComponent?: Enhancer<NextComponentType>
}
| Enhancer<NextComponentType>
export type RenderPageResult = {
html: string
head?: Array<JSX.Element | null>
dataOnly?: true
}
export type RenderPage = (
options?: ComponentsEnhancer
) => RenderPageResult | Promise<RenderPageResult>
export type BaseContext = {
res?: ServerResponse
[k: string]: any
}
export type NEXT_DATA = {
dataManager: string
props: any
page: string
query: ParsedUrlQuery
buildId: string
dynamicBuildId: boolean
assetPrefix?: string
runtimeConfig?: { [key: string]: any }
nextExport?: boolean
dynamicIds?: string[]
err?: Error & { statusCode?: number }
}
/**
* `Next` context
*/
// tslint:disable-next-line interface-name
export interface NextPageContext {
/**
* Error object if encountered during rendering
*/
err?: Error & { statusCode?: number } | null
/**
* `HTTP` request object.
*/
req?: IncomingMessage
/**
* `HTTP` response object.
*/
res?: ServerResponse
/**
* Path section of `URL`.
*/
pathname: string
/**
* Query string section of `URL` parsed as an object.
*/
query: ParsedUrlQuery
/**
* `String` of the actual path including query.
*/
asPath?: string
}
export type AppContextType<R extends BaseRouter = BaseRouter> = {
Component: NextComponentType<NextPageContext>
router: R
ctx: NextPageContext
}
export type AppInitialProps = {
pageProps: any
}
export type AppPropsType<
R extends BaseRouter = BaseRouter,
P = {}
> = AppInitialProps & {
Component: NextComponentType<NextPageContext, any, P>
router: R
}
export type DocumentContext = NextPageContext & {
renderPage: RenderPage
}
export type DocumentInitialProps = RenderPageResult & {
styles?: React.ReactElement[]
}
export type DocumentProps = DocumentInitialProps & {
__NEXT_DATA__: NEXT_DATA
dangerousAsPath: string
ampPath: string
inAmpMode: boolean
hybridAmp: boolean
staticMarkup: boolean
devFiles: string[]
files: string[]
dynamicImports: ManifestItem[]
assetPrefix?: string
canonicalBase: string
}
/**
* Next `API` route request
*/
export type NextApiRequest = IncomingMessage & {
/**
* Object of `query` values from url
*/
query: {
[key: string]: string | string[]
}
/**
* Object of `cookies` from header
*/
cookies: {
[key: string]: string
}
body: any
}
/**
* Send body of response
*/
type Send = (body: any) => void
/**
* Next `API` route response
*/
export type NextApiResponse = ServerResponse & {
/**
* Send data `any` data in reponse
*/
send: Send
/**
* Send data `json` data in reponse
*/
json: Send
status: (statusCode: number) => void
}
/**
* Utils
*/
export function execOnce(this: any, fn: () => any) {
let used = false
return (...args: any) => {
if (!used) {
used = true
fn.apply(this, args)
}
}
}
export function getLocationOrigin() {
const { protocol, hostname, port } = window.location
return `${protocol}//${hostname}${port ? ':' + port : ''}`
}
export function getURL() {
const { href } = window.location
const origin = getLocationOrigin()
return href.substring(origin.length)
}
export function getDisplayName(Component: ComponentType<any>) {
return typeof Component === 'string'
? Component
: Component.displayName || Component.name || 'Unknown'
}
export function isResSent(res: ServerResponse) {
return res.finished || res.headersSent
}
export async function loadGetInitialProps<
C extends BaseContext,
IP = {},
P = {}
>(Component: NextComponentType<C, IP, P>, ctx: C): Promise<IP | null> {
if (process.env.NODE_ENV !== 'production') {
if (Component.prototype && Component.prototype.getInitialProps) {
const message = `"${getDisplayName(
Component
)}.getInitialProps()" is defined as an instance method - visit https://err.sh/zeit/next.js/get-initial-props-as-an-instance-method for more information.`
throw new Error(message)
}
}
// when called from _app `ctx` is nested in `ctx`
const res = ctx.res || (ctx.ctx && ctx.ctx.res)
if (!Component.getInitialProps) {
return {} as any
}
const props = await Component.getInitialProps(ctx)
if (res && isResSent(res)) {
return props
}
// if page component doesn't have getInitialProps
// set cache-control header to stale-while-revalidate
if (ctx.Component && !ctx.Component.getInitialProps) {
const customAppGetInitialProps =
(Component as any).origGetInitialProps &&
(Component as any).origGetInitialProps !== Component.getInitialProps
if (!customAppGetInitialProps && res && res.setHeader) {
res.setHeader('Cache-Control', 's-maxage=86400, stale-while-revalidate')
}
}
if (!props) {
const message = `"${getDisplayName(
Component
)}.getInitialProps()" should resolve to an object. But found "${props}" instead.`
throw new Error(message)
}
return props
}
export const urlObjectKeys = [
'auth',
'hash',
'host',
'hostname',
'href',
'path',
'pathname',
'port',
'protocol',
'query',
'search',
'slashes',
]
export function formatWithValidation(
url: UrlObject,
options?: URLFormatOptions
) {
if (process.env.NODE_ENV === 'development') {
if (url !== null && typeof url === 'object') {
Object.keys(url).forEach(key => {
if (urlObjectKeys.indexOf(key) === -1) {
console.warn(
`Unknown key passed via urlObject into url.format: ${key}`
)
}
})
}
}
return format(url as any, options)
}