File size: 4,091 Bytes
1e92f2d |
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 |
import type { IncomingMessage, ServerResponse } from 'http'
import type {
GetServerSideProps,
GetStaticPaths,
GetStaticProps,
NextComponentType,
PageConfig,
} from '../../../types'
import type { PagesRouteDefinition } from '../../route-definitions/pages-route-definition'
import type { NextParsedUrlQuery } from '../../request-meta'
import type {
PagesRenderContext,
PagesSharedContext,
RenderOpts,
} from '../../render'
import type RenderResult from '../../render-result'
import type { AppType, DocumentType } from '../../../shared/lib/utils'
import {
RouteModule,
type RouteModuleHandleContext,
type RouteModuleOptions,
} from '../route-module'
import { renderToHTMLImpl, renderToHTML } from '../../render'
import * as vendoredContexts from './vendored/contexts/entrypoints'
/**
* The PagesModule is the type of the module exported by the bundled pages
* module.
*/
export type PagesModule = typeof import('../../../build/templates/pages')
/**
* The userland module for a page. This is the module that is exported from the
* page file that contains the page component, page config, and any page data
* fetching functions.
*/
export type PagesUserlandModule = {
/**
* The exported page component.
*/
readonly default: NextComponentType
/**
* The exported page config.
*/
readonly config?: PageConfig
/**
* The exported `getStaticProps` function.
*/
readonly getStaticProps?: GetStaticProps
/**
* The exported `getStaticPaths` function.
*/
readonly getStaticPaths?: GetStaticPaths
/**
* The exported `getServerSideProps` function.
*/
readonly getServerSideProps?: GetServerSideProps
}
/**
* The components that are used to render a page. These aren't tied to the
* specific page being rendered, but rather are the components that are used to
* render all pages.
*/
type PagesComponents = {
/**
* The `App` component. This could be exported by a user's custom `_app` page
* file, or it could be the default `App` component.
*/
readonly App: AppType
/**
* The `Document` component. This could be exported by a user's custom
* `_document` page file, or it could be the default `Document` component.
*/
readonly Document: DocumentType
}
export interface PagesRouteModuleOptions
extends RouteModuleOptions<PagesRouteDefinition, PagesUserlandModule> {
readonly components: PagesComponents
}
/**
* AppRouteRouteHandlerContext is the context that is passed to the route
* handler for app routes.
*/
export interface PagesRouteHandlerContext extends RouteModuleHandleContext {
/**
* The page for the given route.
*/
page: string
/**
* The parsed URL query for the given request.
*/
query: NextParsedUrlQuery
/**
* The shared context used for all page renders.
*/
sharedContext: PagesSharedContext
/**
* The context for the given request.
*/
renderContext: PagesRenderContext
/**
* The arguments for the given request.
/**
* The RenderOpts for the given request which include the specific modules to
* use for rendering.
*/
// TODO: (wyattjoh) break this out into smaller parts, it currently includes the userland components
renderOpts: Omit<RenderOpts, 'Document' | 'App'>
}
export class PagesRouteModule extends RouteModule<
PagesRouteDefinition,
PagesUserlandModule
> {
private readonly components: PagesComponents
constructor(options: PagesRouteModuleOptions) {
super(options)
this.components = options.components
}
public render(
req: IncomingMessage,
res: ServerResponse,
context: PagesRouteHandlerContext
): Promise<RenderResult> {
return renderToHTMLImpl(
req,
res,
context.page,
context.query,
context.renderOpts,
{
App: this.components.App,
Document: this.components.Document,
},
context.sharedContext,
context.renderContext
)
}
}
const vendored = {
contexts: vendoredContexts,
}
// needed for the static build
export { renderToHTML, vendored }
export default PagesRouteModule
|