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
|
/*
* 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 ZipJS from '@zip.js/zip.js';
import type * as Ajv from 'ajv';
import type * as DictionaryData from './dictionary-data';
import type * as DictionaryDatabase from './dictionary-database';
import type * as StructuredContent from './structured-content';
export type OnProgressCallback = (data: ProgressData) => void;
/**
* An enum representing the import step.
* - `-2` `-1` - Dictionary import is uninitialized.
* - `0` - Load dictionary archive and validate index step.
* - `1` - Load schemas and get archive files step.
* - `2` - Load and validate dictionary data step.
* - `3` - Format dictionary data and extended data support step.
* - `4` - Resolve async requirements and import media step.
* - `5` - Add dictionary descriptor and import data step.
*/
export type ImportStep = -2 | -1 | 0 | 1 | 2 | 3 | 4 | 5;
export type ImportStepCount = 6;
export type ProgressData = {
stepIndex: ImportStep;
stepCount: ImportStepCount;
index: number;
count: number;
};
export type ImportResult = {
result: Summary | null;
errors: Error[];
};
export type ImportDetails = {
prefixWildcardsSupported: boolean;
};
export type Summary = {
title: string;
revision: string;
sequenced: boolean;
version: number;
importDate: number;
prefixWildcardsSupported: boolean;
counts: SummaryCounts;
styles: string;
author?: string;
url?: string;
description?: string;
attribution?: string;
sourceLanguage?: string;
targetLanguage?: string;
frequencyMode?: 'occurrence-based' | 'rank-based';
};
export type SummaryDetails = {
prefixWildcardsSupported: boolean;
counts: SummaryCounts;
styles: string;
};
export type SummaryCounts = {
terms: SummaryItemCount;
termMeta: SummaryMetaCount;
kanji: SummaryItemCount;
kanjiMeta: SummaryMetaCount;
tagMeta: SummaryItemCount;
media: SummaryItemCount;
};
export type SummaryItemCount = {
total: number;
};
export type SummaryMetaCount = {
total: number;
[key: string]: number;
};
export type ImportRequirement = (
ImageImportRequirement |
StructuredContentImageImportRequirement
);
export type ImageImportRequirement = {
type: 'image';
target: DictionaryData.TermGlossaryImage;
source: DictionaryData.TermGlossaryImage;
entry: DictionaryDatabase.DatabaseTermEntry;
};
export type StructuredContentImageImportRequirement = {
type: 'structured-content-image';
target: StructuredContent.ImageElement;
source: StructuredContent.ImageElement;
entry: DictionaryDatabase.DatabaseTermEntry;
};
export type ImportRequirementContext = {
fileMap: ArchiveFileMap;
media: Map<string, DictionaryDatabase.MediaDataArrayBufferContent>;
};
export type ArchiveFileMap = Map<string, ZipJS.Entry>;
/**
* An array of tuples of a file type inside a dictionary and its corresponding regular expression.
*/
export type QueryDetails = [fileType: string, fileNameFormat: RegExp][];
/**
* A map of file types inside a dictionary and its matching entries.
*/
export type QueryResult = Map<string, ZipJS.Entry[]>;
export type CompiledSchemaNameArray = [
termBank: CompiledSchemaName,
termMetaBank: CompiledSchemaName,
kanjiBank: CompiledSchemaName,
kanjiMetaBank: CompiledSchemaName,
tagBank: CompiledSchemaName,
];
export type CompiledSchemaValidators = {
dictionaryIndex: Ajv.ValidateFunction<unknown>;
dictionaryTermBankV1: Ajv.ValidateFunction<unknown>;
dictionaryTermBankV3: Ajv.ValidateFunction<unknown>;
dictionaryTermMetaBankV3: Ajv.ValidateFunction<unknown>;
dictionaryKanjiBankV1: Ajv.ValidateFunction<unknown>;
dictionaryKanjiBankV3: Ajv.ValidateFunction<unknown>;
dictionaryKanjiMetaBankV3: Ajv.ValidateFunction<unknown>;
dictionaryTagBankV3: Ajv.ValidateFunction<unknown>;
};
export type CompiledSchemaName = keyof CompiledSchemaValidators;
|