/* * 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}), '*'); } }