aboutsummaryrefslogtreecommitdiff
path: root/ext/js/core/api-map.js
blob: 727c573089eb54033e2f053441983aa83b6975ca (plain)
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
/*
 * Copyright (C) 2023-2024  Yomitan 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 './extension-error.js';

/**
 * @template {import('api-map').ApiSurface} [TApiSurface=never]
 * @template {unknown[]} [TExtraParams=[]]
 * @param {import('api-map').ApiMapInit<TApiSurface, TExtraParams>} init
 * @returns {import('api-map').ApiMap<TApiSurface, TExtraParams>}
 */
export function createApiMap(init) {
    return new Map(init);
}

/**
 * @template {import('api-map').ApiSurface} [TApiSurface=never]
 * @template {unknown[]} [TExtraParams=[]]
 * @param {import('api-map').ApiMap<TApiSurface, TExtraParams>} map
 * @param {import('api-map').ApiMapInit<TApiSurface, TExtraParams>} init
 * @throws {Error}
 */
export function extendApiMap(map, init) {
    for (const [key, value] of init) {
        if (map.has(key)) { throw new Error(`The handler for ${String(key)} has already been registered`); }
        map.set(key, value);
    }
}

/**
 * @template {import('api-map').ApiSurface} [TApiSurface=never]
 * @template {unknown[]} [TExtraParams=[]]
 * @param {import('api-map').ApiMap<TApiSurface, TExtraParams>} map
 * @param {string} name
 * @returns {import('api-map').ApiHandlerAny<TApiSurface, TExtraParams>|undefined}
 */
export function getApiMapHandler(map, name) {
    return map.get(/** @type {import('api-map').ApiNames<TApiSurface>} */ (name));
}

/**
 * @template {import('api-map').ApiSurface} [TApiSurface=never]
 * @template {unknown[]} [TExtraParams=[]]
 * @param {import('api-map').ApiMap<TApiSurface, TExtraParams>} map
 * @param {string} name
 * @param {import('api-map').ApiParamsAny<TApiSurface>} params
 * @param {TExtraParams} extraParams
 * @param {(response: import('core').Response<import('api-map').ApiReturnAny<TApiSurface>>) => void} callback
 * @param {() => void} [handlerNotFoundCallback]
 * @returns {boolean} `true` if async, `false` otherwise.
 */
export function invokeApiMapHandler(map, name, params, extraParams, callback, handlerNotFoundCallback) {
    const handler = getApiMapHandler(map, name);
    if (typeof handler === 'undefined') {
        if (typeof handlerNotFoundCallback === 'function') {
            try {
                handlerNotFoundCallback();
            } catch (error) {
                // NOP
            }
        }
        return false;
    }
    try {
        const promiseOrResult = handler(/** @type {import('core').SafeAny} */ (params), ...extraParams);
        if (promiseOrResult instanceof Promise) {
            /** @type {Promise<unknown>} */ (promiseOrResult).then(
                (result) => { callback({result}); },
                (error) => { callback({error: ExtensionError.serialize(error)}); }
            );
            return true;
        } else {
            callback({result: promiseOrResult});
            return false;
        }
    } catch (error) {
        callback({error: ExtensionError.serialize(error)});
        return false;
    }
}