Allow dictionaries to specify minimum compatible Yomitan version

ext/data/schemas/dictionary-index-schema.json

@@ -23,6 +23,10 @@
             "type": "string",
             "description": "Revision of the dictionary. This value is displayed, and used to check for dictionary updates."
         },
+        "minimumYomitanVersion": {
+            "type": "string",
+            "description": "Minimum version of Yomitan that is compatible with this dictionary."
+        },
         "sequenced": {
             "type": "boolean",
             "default": false,

ext/js/dictionary/dictionary-importer.js

@@ -24,6 +24,7 @@ import {
     ZipReader as ZipReader0,
     configure,
 } from '../../lib/zip.js';
+import {compareRevisions} from './dictionary-data-util.js';
 import {ExtensionError} from '../core/extension-error.js';
 import {parseJson} from '../core/json.js';
 import {toError} from '../core/to-error.js';
@@ -180,8 +181,9 @@ export class DictionaryImporter {
             }
         }
 
+        const yomitanVersion = details.yomitanVersion;
         /** @type {import('dictionary-importer').SummaryDetails} */
-        const summaryDetails = {prefixWildcardsSupported, counts, styles};
+        const summaryDetails = {prefixWildcardsSupported, counts, styles, yomitanVersion};
 
         const summary = this._createSummary(dictionaryTitle, version, index, summaryDetails);
         await dictionaryDatabase.bulkAdd('dictionaries', [summary], 0, 1);
@@ -328,7 +330,15 @@ export class DictionaryImporter {
             styles,
         };
 
-        const {author, url, description, attribution, frequencyMode, isUpdatable, sourceLanguage, targetLanguage} = index;
+        const {minimumYomitanVersion, author, url, description, attribution, frequencyMode, isUpdatable, sourceLanguage, targetLanguage} = index;
+        if (typeof minimumYomitanVersion === 'string') {
+            if (details.yomitanVersion === '0.0.0.0') {
+                // Running a development version of Yomitan
+            } else if (compareRevisions(details.yomitanVersion, minimumYomitanVersion)) {
+                throw new Error(`Dictionary is incompatible with this version of Yomitan (${details.yomitanVersion}; minimum required: ${minimumYomitanVersion})`);
+            }
+            summary.minimumYomitanVersion = minimumYomitanVersion;
+        }
         if (typeof author === 'string') { summary.author = author; }
         if (typeof url === 'string') { summary.url = url; }
         if (typeof description === 'string') { summary.description = description; }

ext/js/pages/settings/dictionary-import-controller.js

@@ -555,6 +555,7 @@ export class DictionaryImportController {
             const optionsFull = await this._settingsController.getOptionsFull();
             const importDetails = {
                 prefixWildcardsSupported: optionsFull.global.database.prefixWildcardsSupported,
+                yomitanVersion: chrome.runtime.getManifest().version,
             };
 
             for (let i = 0; i < importProgressTracker.dictionaryCount; ++i) {

test/database.test.js

@@ -122,7 +122,7 @@ describe('Database', () => {
         // Setup database
         const dictionaryDatabase = new DictionaryDatabase();
         /** @type {import('dictionary-importer').ImportDetails} */
-        const defaultImportDetails = {prefixWildcardsSupported: false};
+        const defaultImportDetails = {prefixWildcardsSupported: false, yomitanVersion: '0.0.0.0'};
 
         // Database not open
         await expect.soft(dictionaryDatabase.deleteDictionary(title, 1000, () => {})).rejects.toThrow('Database not open');
@@ -167,7 +167,7 @@ describe('Database', () => {
                 const testDictionarySource = await createTestDictionaryArchiveData(name);
 
                 /** @type {import('dictionary-importer').ImportDetails} */
-                const detaultImportDetails = {prefixWildcardsSupported: false};
+                const detaultImportDetails = {prefixWildcardsSupported: false, yomitanVersion: '0.0.0.0'};
                 await expect.soft(createDictionaryImporter(expect).importDictionary(dictionaryDatabase, testDictionarySource, detaultImportDetails)).rejects.toThrow('Dictionary has invalid data');
                 await dictionaryDatabase.close();
             });
@@ -199,7 +199,7 @@ describe('Database', () => {
             const {result: importDictionaryResult, errors: importDictionaryErrors} = await dictionaryImporter.importDictionary(
                 dictionaryDatabase,
                 testDictionarySource,
-                {prefixWildcardsSupported: true},
+                {prefixWildcardsSupported: true, yomitanVersion: '0.0.0.0'},
             );
 
             if (importDictionaryResult) {
@@ -324,7 +324,7 @@ describe('Database', () => {
 
                 // Import data
                 const dictionaryImporter = createDictionaryImporter(expect);
-                await dictionaryImporter.importDictionary(dictionaryDatabase, testDictionarySource, {prefixWildcardsSupported: true});
+                await dictionaryImporter.importDictionary(dictionaryDatabase, testDictionarySource, {prefixWildcardsSupported: true, yomitanVersion: '0.0.0.0'});
 
                 // Clear
                 switch (clearMethod) {

test/fixtures/translator-test.js

@@ -49,7 +49,7 @@ export async function createTranslatorContext(dictionaryDirectory, dictionaryNam
     const {errors, result} = await dictionaryImporter.importDictionary(
         dictionaryDatabase,
         testDictionaryData,
-        {prefixWildcardsSupported: true},
+        {prefixWildcardsSupported: true, yomitanVersion: '0.0.0.0'},
     );
 
     expect(errors.length).toEqual(0);

types/ext/dictionary-data.d.ts

@@ -24,6 +24,7 @@ export type Index = {
     version?: IndexVersion;
     title: string;
     revision: string;
+    minimumYomitanVersion?: string;
     sequenced?: boolean;
     isUpdatable?: true;
     indexUrl?: string;

types/ext/dictionary-importer.d.ts

@@ -40,12 +40,14 @@ export type ImportResult = {
 
 export type ImportDetails = {
     prefixWildcardsSupported: boolean;
+    yomitanVersion: string;
 };
 
 export type Summary = {
     title: string;
     revision: string;
     sequenced: boolean;
+    minimumYomitanVersion?: string;
     version: number;
     importDate: number;
     prefixWildcardsSupported: boolean;
@@ -67,6 +69,7 @@ export type SummaryDetails = {
     prefixWildcardsSupported: boolean;
     counts: SummaryCounts;
     styles: string;
+    yomitanVersion: string;
 };
 
 export type SummaryCounts = {