-
Notifications
You must be signed in to change notification settings - Fork 151
/
configuration.ts
100 lines (88 loc) · 3.62 KB
/
configuration.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
/**
* Copyright 2018 The AMP HTML Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS-IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { MessageFromWorker, MessageToWorker } from '../transfer/Messages';
import { Phase } from '../transfer/Phase';
import { HydrateableNode } from '../transfer/TransferrableNodes';
import { DefaultAllowedMutations } from '../transfer/TransferrableMutation';
/**
* The callback for `mutationPump`. If specified, this callback will be called
* for the new set of mutations pending. The callback can either immediately
* call `flush()`, or it can reject mutations, or it can batch them further.
*/
export type MutationPumpFunction = (flush: Function, phase: Phase) => void;
export type LongTaskFunction = (promise: Promise<any>) => void;
export type HydrationFilterPredicate = (node: RenderableElement) => boolean;
export interface InboundWorkerDOMConfiguration {
// ---- Required Values.
authorURL: string;
domURL: string;
// ---- Optional Overrides
// Schedules mutation phase.
mutationPump?: MutationPumpFunction;
// Schedules long task.
longTask?: LongTaskFunction;
// Sanitizer for DOM Mutations
sanitizer?: Sanitizer;
// Hydration Filter Predicate
hydrateFilter?: HydrationFilterPredicate;
// Executor Filter, allow list
executorsAllowed?: Array<number>;
// Extra layer of sandboxing by placing Worker inside of iframe.
sandbox?: { iframeUrl: string };
// ---- Optional Callbacks
// Called when worker consumes the page's initial DOM state.
onCreateWorker?: (initialDOM: RenderableElement, strings: Array<string>, skeleton: HydrateableNode, keys: Array<string>) => void;
// Called before a message is sent to the worker.
onSendMessage?: (message: MessageToWorker) => void;
// Called after a message is received from the worker.
onReceiveMessage?: (message: MessageFromWorker) => void;
}
export interface WorkerDOMConfiguration {
// ---- Required Values.
authorURL: string;
domURL: string;
// ---- Optional, with defaults
// Schedules mutation phase.
mutationPump: MutationPumpFunction;
// Executor Filter, allow list
executorsAllowed: Array<number>;
// ---- Optional Overrides
// Schedules long task.
longTask?: LongTaskFunction;
// Sanitizer for DOM Mutations
sanitizer?: Sanitizer;
// Hydration Filter Predicate
hydrateFilter?: HydrationFilterPredicate;
// Extra layer of sandboxing by placing Worker inside of iframe.
sandbox?: { iframeUrl: string };
// ---- Optional Callbacks
// Called when worker consumes the page's initial DOM state.
onCreateWorker?: (initialDOM: RenderableElement, strings: Array<string>, skeleton: HydrateableNode, keys: Array<string>) => void;
// Called before a message is sent to the worker.
onSendMessage?: (message: MessageToWorker) => void;
// Called after a message is received from the worker.
onReceiveMessage?: (message: MessageFromWorker) => void;
}
export function normalizeConfiguration(config: InboundWorkerDOMConfiguration): WorkerDOMConfiguration {
return Object.assign(
{},
{
mutationPump: requestAnimationFrame.bind(null),
executorsAllowed: DefaultAllowedMutations,
},
config,
);
}