aboutsummaryrefslogtreecommitdiff
path: root/types/ext/dom-data-binder.d.ts
blob: 3f12a455a976b2e5331b4ebffca0475797bedfb4 (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
/*
 * 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 type * as TaskAccumulator from './task-accumulator';

export type CreateElementMetadataCallback<T = unknown> = (element: Element) => T | undefined;

export type CompareElementMetadataCallback<T = unknown> = (metadata1: T, metadata2: T) => boolean;

export type GetValuesCallback<T = unknown> = (args: GetValuesDetails<T>[]) => Promise<TaskResult[]>;

export type SetValuesCallback<T = unknown> = (args: SetValuesDetails<T>[]) => Promise<TaskResult[]>;

export type GetValuesDetails<T = unknown> = {
    element: Element;
    metadata: T;
};

export type SetValuesDetails<T = unknown> = {
    element: Element;
    metadata: T;
    value: ValueType;
};

export type OnErrorCallback<T = unknown> = (error: Error, stale: boolean, element: Element, metadata: T) => void;

export type ElementObserver<T = unknown> = {
    element: Element;
    type: NormalizedElementType;
    value: unknown;
    hasValue: boolean;
    onChange: null | (() => void);
    metadata: T;
};

export type SettingChangedEventData = {
    value: boolean | string | number;
};

export type SettingChangedEvent = CustomEvent<SettingChangedEventData>;

export type NormalizedElementType = 'textarea' | 'select' | 'text' | 'checkbox' | 'number' | null;

export type UpdateTaskValue = {all: boolean};

export type AssignTaskValue = {value: ValueType};

export type ValueType = boolean | string | number | null;

export type UpdateTask<T = unknown> = [
    key: ElementObserver<T> | null,
    task: TaskAccumulator.Task<UpdateTaskValue>,
];

export type AssignTask<T = unknown> = [
    key: ElementObserver<T> | null,
    task: TaskAccumulator.Task<AssignTaskValue>,
];

export type ApplyTarget<T = unknown> = [
    observer: ElementObserver<T>,
    task: TaskAccumulator.Task<UpdateTaskValue> | TaskAccumulator.Task<AssignTaskValue> | null,
];

export type TaskResultError = {
    error: Error;
    result?: undefined;
};

export type TaskResultSuccess<T = unknown> = {
    error?: undefined;
    result: T;
};

export type TaskResult<T = unknown> = TaskResultError | TaskResultSuccess<T>;