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
|
/*
* Copyright (C) 2023 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {ExtensionError} from '../../core/extension-error.js';
export class TemplateRendererFrameApi {
/**
* @param {import('./template-renderer.js').TemplateRenderer} templateRenderer
*/
constructor(templateRenderer) {
/** @type {import('./template-renderer.js').TemplateRenderer} */
this._templateRenderer = templateRenderer;
/** @type {import('core').MessageHandlerMap} */
this._windowMessageHandlers = new Map(/** @type {import('core').MessageHandlerArray} */ ([
['render', {async: false, handler: this._onRender.bind(this)}],
['renderMulti', {async: false, handler: this._onRenderMulti.bind(this)}],
['getModifiedData', {async: false, handler: this._onGetModifiedData.bind(this)}]
]));
}
/**
* @returns {void}
*/
prepare() {
window.addEventListener('message', this._onWindowMessage.bind(this), false);
this._postMessage(window.parent, 'ready', {}, null);
}
// Private
/**
* @param {MessageEvent<import('template-renderer-frame-api').MessageData>} e
*/
_onWindowMessage(e) {
const {source, data: {action, params, id}} = e;
const messageHandler = this._windowMessageHandlers.get(action);
if (typeof messageHandler === 'undefined') { return; }
this._onWindowMessageInner(messageHandler, action, params, /** @type {Window} */ (source), id);
}
/**
* @param {import('core').MessageHandlerDetails} handlerItem
* @param {string} action
* @param {import('core').SerializableObject} params
* @param {Window} source
* @param {?string} id
*/
async _onWindowMessageInner({handler, async}, action, params, source, id) {
let response;
try {
let result = handler(params);
if (async) {
result = await result;
}
response = {result};
} catch (error) {
response = {error: ExtensionError.serialize(error)};
}
if (typeof id === 'undefined') { return; }
this._postMessage(source, `${action}.response`, response, id);
}
/**
* @param {{template: string, data: import('template-renderer').PartialOrCompositeRenderData, type: import('anki-templates').RenderMode}} event
* @returns {import('template-renderer').RenderResult}
*/
_onRender({template, data, type}) {
return this._templateRenderer.render(template, data, type);
}
/**
* @param {{items: import('template-renderer').RenderMultiItem[]}} event
* @returns {import('core').Response<import('template-renderer').RenderResult>[]}
*/
_onRenderMulti({items}) {
return this._templateRenderer.renderMulti(items);
}
/**
* @param {{data: import('template-renderer').CompositeRenderData, type: import('anki-templates').RenderMode}} event
* @returns {import('anki-templates').NoteData}
*/
_onGetModifiedData({data, type}) {
const result = this._templateRenderer.getModifiedData(data, type);
return this._clone(result);
}
/**
* @template [T=unknown]
* @param {T} value
* @returns {T}
*/
_clone(value) {
return JSON.parse(JSON.stringify(value));
}
/**
* @param {Window} target
* @param {string} action
* @param {import('core').SerializableObject} params
* @param {?string} id
*/
_postMessage(target, action, params, id) {
target.postMessage(/** @type {import('template-renderer-frame-api').MessageData} */ ({action, params, id}), '*');
}
}
|