-
Notifications
You must be signed in to change notification settings - Fork 3
/
server.d.ts
335 lines (299 loc) · 9.56 KB
/
server.d.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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
/// <reference path="./server-modules.d.ts" />
import type { QwikManifest } from './optimizer';
import type { ResolvedManifest } from './optimizer';
import type { SnapshotResult } from '.';
import type { StreamWriter } from '.';
import type { SymbolMapperFn } from './optimizer';
/**
* Provides the `qwikloader.js` file as a string. Useful for tooling to inline the qwikloader script
* into HTML.
*
* @public
*/
export declare function getQwikLoaderScript(opts?: {
debug?: boolean;
}): string;
/**
* Provides the `qwik-prefetch-service-worker.js` file as a string. Useful for tooling to inline the
* qwik-prefetch-service-worker script into HTML.
*
* @public
*/
export declare function getQwikPrefetchWorkerScript(opts?: {
debug?: boolean;
}): string;
/** @public */
declare interface GlobalInjections {
tag: string;
attributes?: {
[key: string]: string;
};
location: 'head' | 'body';
}
/** @public */
export declare interface InOrderAuto {
strategy: 'auto';
maximunInitialChunk?: number;
maximunChunk?: number;
}
/** @public */
declare interface InOrderDirect {
strategy: 'direct';
}
/** @public */
export declare interface InOrderDisabled {
strategy: 'disabled';
}
/** @public */
export declare type InOrderStreaming = InOrderAuto | InOrderDisabled | InOrderDirect;
/** @public */
export declare interface PrefetchImplementation {
/**
* `js-append`: Use JS runtime to create each `<link>` and append to the body.
*
* `html-append`: Render each `<link>` within html, appended at the end of the body.
*/
linkInsert?: 'js-append' | 'html-append' | null;
/**
* Value of the `<link rel="...">` attribute when link is used. Defaults to `prefetch` if links
* are inserted.
*/
linkRel?: 'prefetch' | 'preload' | 'modulepreload' | null;
/**
* `always`: Always include the worker fetch JS runtime.
*
* `no-link-support`: Only include the worker fetch JS runtime when the browser doesn't support
* `<link>` prefetch/preload/modulepreload.
*/
workerFetchInsert?: 'always' | 'no-link-support' | null;
/**
* Dispatch a `qprefetch` event with detail data containing the bundles that should be prefetched.
* The event dispatch script will be inlined into the document's HTML so any listeners of this
* event should already be ready to handle the event.
*
* This implementation will inject a script similar to:
*
* ```
* <script type="module">
* document.dispatchEvent(new CustomEvent("qprefetch", { detail:{ "bundles": [...] } }))
* </script>
* ```
*
* By default, the `prefetchEvent` implementation will be set to `always`.
*/
prefetchEvent?: 'always' | null;
}
/** @public */
export declare interface PrefetchResource {
url: string;
imports: PrefetchResource[];
}
/** @public */
export declare interface PrefetchStrategy {
implementation?: PrefetchImplementation;
symbolsToPrefetch?: SymbolsToPrefetch;
}
/** @public */
declare interface QwikBundle {
size: number;
/** Not precise, but an indication of whether this import may be a task */
isTask?: boolean;
symbols?: string[];
imports?: string[];
dynamicImports?: string[];
origins?: string[];
}
/** @public */
export declare interface QwikLoaderOptions {
include?: 'always' | 'never' | 'auto';
position?: 'top' | 'bottom';
}
/**
* The metadata of the build. One of its uses is storing where QRL symbols are located.
*
* @public
*/
declare interface QwikManifest_2 {
/** Content hash of the manifest, if this changes, the code changed */
manifestHash: string;
/** QRL symbols */
symbols: {
[symbolName: string]: QwikSymbol;
};
/** Where QRLs are located */
mapping: {
[symbolName: string]: string;
};
/** All code bundles, used to know the import graph */
bundles: {
[fileName: string]: QwikBundle;
};
/** CSS etc to inject in the document head */
injections?: GlobalInjections[];
version: string;
options?: {
target?: string;
buildMode?: string;
entryStrategy?: {
[key: string]: any;
};
};
platform?: {
[name: string]: string;
};
}
/**
* Options which determine how the Qwik Prefetch Service Worker is added to the document.
*
* Qwik Prefetch Service Worker is used to prefetch resources so that the QwikLoader will always
* have a cache hit. This will ensure that there will not be any delays for the end user while
* interacting with the application.
*
* @public
*/
declare interface QwikPrefetchServiceWorkerOptions {
/**
* Should the Qwik Prefetch Service Worker be added to the container. Defaults to `false` until
* the QwikCity Service Worker is deprecated.
*/
include?: boolean;
/**
* Where should the Qwik Prefetch Service Worker be added to the container. Defaults to `top` to
* get prefetching going as fast as possible.
*/
position?: 'top' | 'bottom';
}
/** @public */
declare interface QwikSymbol {
origin: string;
displayName: string;
hash: string;
canonicalFilename: string;
ctxKind: 'function' | 'event';
ctxName: string;
captures: boolean;
parent: string | null;
loc: [number, number];
}
/** @public */
export declare type Render = RenderToString | RenderToStream;
/** @public */
export declare interface RenderOptions extends SerializeDocumentOptions {
/** Defaults to `true` */
snapshot?: boolean;
/**
* Specifies the root of the JS files of the client build. Setting a base, will cause the render
* of the `q:base` attribute in the `q:container` element.
*/
base?: string | ((options: RenderOptions) => string);
/** Language to use when rendering the document. */
locale?: string | ((options: RenderOptions) => string);
/**
* Specifies if the Qwik Loader script is added to the document or not.
*
* Defaults to `{ include: true }`.
*/
qwikLoader?: QwikLoaderOptions;
/**
* Specifies if the Qwik Prefetch Service Worker script is added to the document or not.
*
* Defaults to `{ include: false }`. NOTE: This may be change in the future.
*/
qwikPrefetchServiceWorker?: QwikPrefetchServiceWorkerOptions;
prefetchStrategy?: PrefetchStrategy | null;
/**
* When set, the app is serialized into a fragment. And the returned html is not a complete
* document. Defaults to `html`
*/
containerTagName?: string;
containerAttributes?: Record<string, string>;
serverData?: Record<string, any>;
}
/** @public */
export declare interface RenderResult {
prefetchResources: PrefetchResource[];
snapshotResult: SnapshotResult | undefined;
isStatic: boolean;
manifest?: QwikManifest;
/** @internal TODO: Move to snapshotResult */
_symbols?: string[];
}
/** @public */
export declare type RenderToStream = (opts: RenderToStreamOptions) => Promise<RenderToStreamResult>;
/**
* Creates a server-side `document`, renders to root node to the document, then serializes the
* document to a string.
*
* @public
*/
export declare function renderToStream(rootNode: any, opts: RenderToStreamOptions): Promise<RenderToStreamResult>;
/** @public */
export declare interface RenderToStreamOptions extends RenderOptions {
stream: StreamWriter;
streaming?: StreamingOptions;
}
/** @public */
export declare interface RenderToStreamResult extends RenderResult {
flushes: number;
size: number;
timing: {
firstFlush: number;
render: number;
snapshot: number;
};
}
/** @public */
export declare type RenderToString = (opts: RenderToStringOptions) => Promise<RenderToStringResult>;
/**
* Creates a server-side `document`, renders to root node to the document, then serializes the
* document to a string.
*
* @public
*/
export declare function renderToString(rootNode: any, opts?: RenderToStringOptions): Promise<RenderToStringResult>;
/** @public */
export declare interface RenderToStringOptions extends RenderOptions {
}
/** @public */
export declare interface RenderToStringResult extends RenderResult {
html: string;
timing: {
render: number;
snapshot: number;
};
}
/** @public */
declare interface ResolvedManifest_2 {
mapper: SymbolMapper;
manifest: QwikManifest_2;
}
/** @public */
export declare function resolveManifest(manifest: QwikManifest | ResolvedManifest_2 | undefined): ResolvedManifest_2 | undefined;
/** @public */
export declare interface SerializeDocumentOptions {
manifest?: QwikManifest | ResolvedManifest;
symbolMapper?: SymbolMapperFn;
debug?: boolean;
}
/** @public */
export declare function setServerPlatform(manifest: QwikManifest | ResolvedManifest | undefined): Promise<void>;
/** @public */
export declare interface StreamingOptions {
inOrder?: InOrderStreaming;
}
/** @public */
declare type SymbolMapper = Record<string, readonly [symbol: string, chunk: string]>;
/**
* Auto: Prefetch all possible QRLs used by the document. Default
*
* @public
*/
export declare type SymbolsToPrefetch = 'auto' | ((opts: {
manifest: QwikManifest;
}) => PrefetchResource[]);
/** @public */
export declare const versions: {
readonly qwik: string;
readonly qwikDom: string;
};
export { }