-
Notifications
You must be signed in to change notification settings - Fork 8
/
core.js
342 lines (308 loc) · 8.93 KB
/
core.js
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
336
337
338
339
340
341
342
const noContext = Symbol('noContext')
const orphanMap = {}
const resolved = Promise.resolve()
const orphanResolveQueue = {
contexts: new Set(),
running: false,
add(context) {
this.contexts.add(context)
if (!this.running) {
this.running = true
resolved.then(() => {
this.contexts.forEach((context) => {
const orphans = orphanMap[context]
orphans.forEach(({ setter, payload }, orphan) => {
const handled = sendContextEvent(orphan, context, payload, setter)
if (handled) {
orphans.delete(orphan)
}
})
})
this.contexts.clear()
this.running = false
})
}
},
}
function addOrphan(el, name, payload, setter) {
const orphans = orphanMap[name] || (orphanMap[name] = new Map())
orphans.set(el, { setter, payload })
}
function removeOrphan(el, name) {
const orphans = orphanMap[name]
if (orphans) {
orphans.delete(el)
}
}
export class ContextRequestEvent extends Event {
constructor(context, callback, subscribe) {
super('context-request', {
bubbles: true,
cancelable: true,
composed: true,
})
this.context = context
this.callback = callback
this.subscribe = subscribe
}
}
function sendContextEvent(consumer, context, payload, setter) {
let handled
const callback = (value, unsubscribe) => {
if (!handled) {
registerProvider(consumer, context, unsubscribe)
}
setter(consumer, value, payload)
handled = true
}
const event = new ContextRequestEvent(context, callback, true)
consumer.dispatchEvent(event)
return handled
}
/**
* @typedef {Object} Context
*/
/**
* @typedef {Object} ContextGetter
* @property {Function} getter Function that is called in provider
* @property {any} [payload] Payload passed to getter
*/
/**
* @param {string} key Identify the context
* @return {Context}
*/
function createContext(key) {
return {
key,
toString() {
return this.key
},
}
}
/**
* @param {HTMLElement} provider HTMLElement acting as a context provider
* @param {Object} options
* @param {Function} options.getter
* @param {*} [options.payload]
* @return {*}
*/
function getProviderValue(provider, { getter, payload }) {
return getter(provider, payload)
}
/**
* @description Default context getter implementation. Just returns the payload
* @param {HTMLElement} provider HTMLElement acting as a context provider
* @param {*} payload Options passed to the callback
* @return {*}
*/
function providerGetter(provider, payload) {
return payload
}
/**
* @param {HTMLElement} provider HTMLElement acting as a context provider
* @param {string | Context} context Context identifier
* @param {*} payload Value passed to getter
* @param {Function} [getter=providerGetter]
*/
function registerContext(provider, context, payload, getter = providerGetter) {
const observerMap =
provider.__wcContextObserverMap || (provider.__wcContextObserverMap = {})
const providedContexts =
provider.__wcContextProvided || (provider.__wcContextProvided = {})
providedContexts[context] = { getter, payload }
const observers = observerMap[context] || (observerMap[context] = [])
const orphans = orphanMap[context]
provider.addEventListener(`context-request`, (event) => {
const { target, callback, subscribe } = event
if (event.context !== context || typeof callback !== 'function') {
return
}
event.stopPropagation()
const value = getProviderValue(provider, providedContexts[context])
if (subscribe || value === noContext) {
const unsubscribe = () => {
removeObserver(provider, context, target)
}
observers.push({
consumer: target,
callback,
unsubscribe,
once: !subscribe,
})
if (value !== noContext) {
callback(value, unsubscribe)
}
runListeners(provider, context, 'observe', observers.length)
} else {
callback(value)
}
})
if (orphans && orphans.size) {
orphanResolveQueue.add(context)
}
}
/**
* @param {HTMLElement} provider HTMLElement that provides a context
* @param {string | Context} context Context identifier
* @param {string} caller Function caller identifier
* @return {ContextGetter}
*/
function getProvidedContext(provider, context, caller) {
const providedContexts = provider.__wcContextProvided
const providedContext = providedContexts && providedContexts[context]
if (!providedContext) {
throw new Error(`${caller}: "${context.name || context}" is not registered`)
}
return providedContext
}
/**
* @param {HTMLElement} provider HTMLElement that provides a context
* @param {string | Context} context Context identifier
* @param {*} [payload=context] Value passed to provider context getter
*/
function updateContext(provider, context, payload) {
const observerMap = provider.__wcContextObserverMap
const providedContext = getProvidedContext(provider, context, 'updateContext')
if (payload !== undefined) {
providedContext.payload = payload
}
const value = getProviderValue(provider, providedContext)
if (value === noContext) {
return
}
const observers = observerMap && observerMap[context]
// if we got here, observers is necessarily defined
observers.forEach(({ consumer, callback, unsubscribe, once }) => {
if (once) {
unsubscribe()
unsubscribe = undefined
}
callback.call(consumer, value, unsubscribe)
})
}
function consumerSetter(consumer, value, name) {
const oldValue = consumer[name]
if (oldValue !== value) {
consumer[name] = value
if (typeof consumer.contextChangedCallback === 'function') {
consumer.contextChangedCallback(name, oldValue, value)
}
}
}
function runListeners(provider, context, type, count) {
const providedContext = getProvidedContext(provider, context, 'runListeners')
const listeners = providedContext.listeners
if (listeners) {
for (const listener of listeners) {
if (listener.type === type) {
listener.callback.call(provider, { count })
}
}
}
}
function registerProvider(consumer, context, provider) {
const providerMap =
consumer.__wcContextProviderMap || (consumer.__wcContextProviderMap = {})
providerMap[context] = provider
}
/**
* @description Observes a context in a consumer. Optionally define how the context value is set
* @param {HTMLElement} consumer HTMLElement that consumes a context
* @param {string | Context} context Context identifier
* @param {*} [payload=context] Value passed to setter
* @param {Function} [setter=consumerSetter]
*/
function observeContext(
consumer,
context,
payload = context,
setter = consumerSetter
) {
const handled = sendContextEvent(consumer, context, payload, setter)
if (!handled) {
addOrphan(consumer, context, payload, setter)
}
}
function removeObserver(provider, context, consumer) {
const observerMap = provider.__wcContextObserverMap
const observers = observerMap[context]
const consumerIndex = observers.findIndex(
(observer) => observer.consumer === consumer
)
if (consumerIndex !== -1) {
observers.splice(consumerIndex, 1)
}
runListeners(provider, context, 'unobserve', observers.length)
}
/**
* @description Unobserves a context in a consumer
* @param {HTMLElement} consumer HTMLElement that consumes a context
* @param {string | Context} context Context identifier
*/
function unobserveContext(consumer, context) {
const providerMap = consumer.__wcContextProviderMap
if (providerMap) {
const unsubscribe = providerMap[context]
if (unsubscribe) {
unsubscribe()
providerMap[context] = undefined
}
}
removeOrphan(consumer, context)
}
/**
* @param {HTMLElement} provider
* @param {string | Context} context Context identifier
* @param {Function} callback
*/
function onContextObserve(provider, context, callback) {
const providedContext = getProvidedContext(
provider,
context,
'onContextObserve'
)
const listeners =
providedContext.listeners || (providedContext.listeners = [])
listeners.push({ callback, type: 'observe' })
}
/**
* @param {HTMLElement} provider
* @param {string | Context} context Context identifier
* @param {Function} callback
*/
function onContextUnobserve(provider, context, callback) {
const providedContext = getProvidedContext(
provider,
context,
'onContextUnobserve'
)
const listeners =
providedContext.listeners || (providedContext.listeners = [])
listeners.push({ callback, type: 'unobserve' })
}
/**
*
*
* @param {HTMLElement} consumer
* @param {Context | string} context
* @return {*}
*/
async function getContext(consumer, context) {
return new Promise((resolve) => {
const event = new ContextRequestEvent(context, resolve, false)
consumer.dispatchEvent(event)
})
}
export {
noContext,
createContext,
registerContext,
updateContext,
observeContext,
unobserveContext,
consumerSetter,
providerGetter,
onContextObserve,
onContextUnobserve,
getContext,
}