aboutsummaryrefslogtreecommitdiff
path: root/ext/js
diff options
context:
space:
mode:
Diffstat (limited to 'ext/js')
-rw-r--r--ext/js/background/backend.js87
-rw-r--r--ext/js/comm/anki-connect.js57
-rw-r--r--ext/js/data/anki-note-builder.js3
-rw-r--r--ext/js/display/display-anki.js55
-rw-r--r--ext/js/input/hotkey-help-controller.js32
5 files changed, 212 insertions, 22 deletions
diff --git a/ext/js/background/backend.js b/ext/js/background/backend.js
index 182f11aa..cd44a07f 100644
--- a/ext/js/background/backend.js
+++ b/ext/js/background/backend.js
@@ -544,22 +544,89 @@ export class Backend {
return await this._anki.addNote(note);
}
+ /**
+ * @param {import('anki').Note[]} notes
+ * @returns {Promise<({ canAdd: true; } | { canAdd: false; error: string; })[]>}
+ */
+ async detectDuplicateNotes(notes) {
+ // `allowDuplicate` is on for all notes by default, so we temporarily set it to false
+ // to check which notes are duplicates.
+ const notesNoDuplicatesAllowed = notes.map((note) => ({...note, options: {...note.options, allowDuplicate: false}}));
+
+ return await this._anki.canAddNotesWithErrorDetail(notesNoDuplicatesAllowed);
+ }
+
+ /**
+ * Partitions notes between those that can / cannot be added.
+ * It further sets the `isDuplicate` strings for notes that have a duplicate.
+ * @param {import('anki').Note[]} notes
+ * @returns {Promise<import('backend').CanAddResults>}
+ */
+ async partitionAddibleNotes(notes) {
+ const canAddResults = await this.detectDuplicateNotes(notes);
+
+ /** @type {{ note: import('anki').Note, isDuplicate: boolean }[]} */
+ const canAddArray = [];
+
+ /** @type {import('anki').Note[]} */
+ const cannotAddArray = [];
+
+ for (let i = 0; i < canAddResults.length; i++) {
+ const result = canAddResults[i];
+
+ // If the note is a duplicate, the error is "cannot create note because it is a duplicate".
+ if (result.canAdd) {
+ canAddArray.push({note: notes[i], isDuplicate: false});
+ } else if (result.error.endsWith('duplicate')) {
+ canAddArray.push({note: notes[i], isDuplicate: true});
+ } else {
+ cannotAddArray.push(notes[i]);
+ }
+ }
+
+ return {canAddArray, cannotAddArray};
+ }
+
/** @type {import('api').ApiHandler<'getAnkiNoteInfo'>} */
async _onApiGetAnkiNoteInfo({notes, fetchAdditionalInfo}) {
- /** @type {import('anki').NoteInfoWrapper[]} */
- const results = [];
+ const {canAddArray, cannotAddArray} = await this.partitionAddibleNotes(notes);
+
/** @type {{note: import('anki').Note, info: import('anki').NoteInfoWrapper}[]} */
- const cannotAdd = [];
- const canAddArray = await this._anki.canAddNotes(notes);
+ const cannotAdd = cannotAddArray.filter((note) => isNoteDataValid(note)).map((note) => ({note, info: {canAdd: false, valid: false, noteIds: null}}));
+
+ /** @type {import('anki').NoteInfoWrapper[]} */
+ const results = cannotAdd.map(({info}) => info);
+
+ /** @type {import('anki').Note[]} */
+ const duplicateNotes = [];
+
+ /** @type {number[]} */
+ const originalIndices = [];
+
+ for (let i = 0; i < canAddArray.length; i++) {
+ if (canAddArray[i].isDuplicate) {
+ duplicateNotes.push(canAddArray[i].note);
+ // Keep original indices to locate duplicate inside `duplicateNoteIds`
+ originalIndices.push(i);
+ }
+ }
+
+ const duplicateNoteIds = await this._anki.findNoteIds(duplicateNotes);
+
+ for (let i = 0; i < canAddArray.length; ++i) {
+ const {note, isDuplicate} = canAddArray[i];
- for (let i = 0; i < notes.length; ++i) {
- const note = notes[i];
- let canAdd = canAddArray[i];
const valid = isNoteDataValid(note);
- if (!valid) { canAdd = false; }
- const info = {canAdd, valid, noteIds: null};
+
+ const info = {
+ canAdd: valid,
+ valid,
+ noteIds: isDuplicate ? duplicateNoteIds[originalIndices.indexOf(i)] : null
+ };
+
results.push(info);
- if (!canAdd && valid) {
+
+ if (!valid) {
cannotAdd.push({note, info});
}
}
diff --git a/ext/js/comm/anki-connect.js b/ext/js/comm/anki-connect.js
index 0bf38bda..a763f394 100644
--- a/ext/js/comm/anki-connect.js
+++ b/ext/js/comm/anki-connect.js
@@ -140,6 +140,17 @@ export class AnkiConnect {
}
/**
+ * @param {import('anki').Note[]} notes
+ * @returns {Promise<({ canAdd: true } | { canAdd: false, error: string })[]>}
+ */
+ async canAddNotesWithErrorDetail(notes) {
+ if (!this._enabled) { return []; }
+ await this._checkVersion();
+ const result = await this._invoke('canAddNotesWithErrorDetail', {notes});
+ return this._normalizeCanAddNotesWithErrorDetailArray(result, notes.length);
+ }
+
+ /**
* @param {import('anki').NoteId[]} noteIds
* @returns {Promise<(?import('anki').NoteInfo)[]>}
*/
@@ -581,6 +592,52 @@ export class AnkiConnect {
/**
* @param {unknown} result
+ * @param {number} expectedCount
+ * @returns {import('anki-connect.js').CanAddResult[]}
+ * @throws {Error}
+ */
+ _normalizeCanAddNotesWithErrorDetailArray(result, expectedCount) {
+ if (!Array.isArray(result)) {
+ throw this._createUnexpectedResultError('array', result, '');
+ }
+ if (expectedCount !== result.length) {
+ throw this._createError(`Unexpected result array size: expected ${expectedCount}, received ${result.length}`, result);
+ }
+ /** @type {import('anki-connect.js').CanAddResult[]} */
+ const result2 = [];
+ for (let i = 0; i < expectedCount; ++i) {
+ const item = /** @type {unknown} */ (result[i]);
+ if (item === null || typeof item !== 'object') {
+ throw this._createError(`Unexpected result type at index ${i}: expected object, received ${this._getTypeName(item)}`, result);
+ }
+
+ const {canAdd, error} = /** @type {{[key: string]: unknown}} */ (item);
+ if (typeof canAdd !== 'boolean') {
+ throw this._createError(`Unexpected result type at index ${i}, field canAdd: expected boolean, received ${this._getTypeName(canAdd)}`, result);
+ }
+
+ if (canAdd && typeof error !== 'undefined') {
+ throw this._createError(`Unexpected result type at index ${i}, field error: expected undefined, received ${this._getTypeName(error)}`, result);
+ }
+ if (!canAdd && typeof error !== 'string') {
+ throw this._createError(`Unexpected result type at index ${i}, field error: expected string, received ${this._getTypeName(error)}`, result);
+ }
+
+ if (canAdd) {
+ result2.push({canAdd});
+ } else if (typeof error === 'string') {
+ const item2 = {
+ canAdd,
+ error
+ };
+ result2.push(item2);
+ }
+ }
+ return result2;
+ }
+
+ /**
+ * @param {unknown} result
* @returns {(?import('anki').NoteInfo)[]}
* @throws {Error}
*/
diff --git a/ext/js/data/anki-note-builder.js b/ext/js/data/anki-note-builder.js
index e156103a..6a6a6177 100644
--- a/ext/js/data/anki-note-builder.js
+++ b/ext/js/data/anki-note-builder.js
@@ -54,7 +54,6 @@ export class AnkiNoteBuilder {
fields,
tags = [],
requirements = [],
- checkForDuplicates = true,
duplicateScope = 'collection',
duplicateScopeCheckAllModels = false,
resultOutputMode = 'split',
@@ -111,7 +110,7 @@ export class AnkiNoteBuilder {
deckName,
modelName,
options: {
- allowDuplicate: !checkForDuplicates,
+ allowDuplicate: true,
duplicateScope,
duplicateScopeOptions: {
deckName: duplicateScopeDeckName,
diff --git a/ext/js/display/display-anki.js b/ext/js/display/display-anki.js
index 9a6b96c7..b7d118da 100644
--- a/ext/js/display/display-anki.js
+++ b/ext/js/display/display-anki.js
@@ -371,6 +371,36 @@ export class DisplayAnki {
}
/**
+ * @param {HTMLButtonElement} button
+ */
+ _showDuplicateAddButton(button) {
+ const isKanjiAdd = button.dataset.mode === 'term-kanji';
+
+ const title = button.getAttribute('title');
+ if (title) {
+ button.setAttribute('title', title.replace(/Add (?!duplicate)/, 'Add duplicate '));
+ }
+
+ // eslint-disable-next-line no-underscore-dangle
+ const hotkeyLabel = this._display._hotkeyHelpController.getHotkeyLabel(button);
+
+ if (hotkeyLabel) {
+ if (hotkeyLabel === 'Add expression ({0})') {
+ // eslint-disable-next-line no-underscore-dangle
+ this._display._hotkeyHelpController.setHotkeyLabel(button, 'Add duplicate expression ({0})');
+ } else if (hotkeyLabel === 'Add reading ({0})') {
+ // eslint-disable-next-line no-underscore-dangle
+ this._display._hotkeyHelpController.setHotkeyLabel(button, 'Add duplicate reading ({0})');
+ }
+ }
+
+ const actionIcon = button.querySelector('.action-icon');
+ if (actionIcon instanceof HTMLElement) {
+ actionIcon.dataset.icon = isKanjiAdd ? 'add-duplicate-term-kanji' : 'add-duplicate-term-kana';
+ }
+ }
+
+ /**
* @param {import('display-anki').DictionaryEntryDetails[]} dictionaryEntryDetails
*/
_updateAdderButtons(dictionaryEntryDetails) {
@@ -383,6 +413,11 @@ export class DisplayAnki {
if (button !== null) {
button.disabled = !canAdd;
button.hidden = (ankiError !== null);
+
+ // If entry has noteIds, show the "add duplicate" button.
+ if (Array.isArray(noteIds) && noteIds.length > 0) {
+ this._showDuplicateAddButton(button);
+ }
}
if (Array.isArray(noteIds) && noteIds.length > 0) {
@@ -394,6 +429,7 @@ export class DisplayAnki {
this._setupTagsIndicator(i, noteInfos);
}
}
+
this._updateViewNoteButton(i, allNoteIds !== null ? [...allNoteIds] : [], false);
}
}
@@ -506,7 +542,9 @@ export class DisplayAnki {
allErrors.push(toError(e));
}
}
- button.disabled = true;
+ // Now that this dictionary entry has a duplicate in Anki, show the "add duplicate" buttons.
+ this._showDuplicateAddButton(button);
+
this._updateViewNoteButton(dictionaryEntryIndex, [noteId], true);
}
}
@@ -615,7 +653,6 @@ export class DisplayAnki {
* @returns {Promise<import('display-anki').DictionaryEntryDetails[]>}
*/
async _getDictionaryEntryDetails(dictionaryEntries) {
- const forceCanAddValue = (this._checkForDuplicates ? null : true);
const fetchAdditionalInfo = (this._displayTags !== 'never');
const notePromises = [];
@@ -638,14 +675,13 @@ export class DisplayAnki {
let infos;
let ankiError = null;
try {
- if (forceCanAddValue !== null) {
- if (!await this._display.application.api.isAnkiConnected()) {
- throw new Error('Anki not connected');
- }
- infos = this._getAnkiNoteInfoForceValue(notes, forceCanAddValue);
- } else {
- infos = await this._display.application.api.getAnkiNoteInfo(notes, fetchAdditionalInfo);
+ if (!await this._display.application.api.isAnkiConnected()) {
+ throw new Error('Anki not connected');
}
+
+ infos = this._checkForDuplicates ?
+ await this._display.application.api.getAnkiNoteInfo(notes, fetchAdditionalInfo) :
+ this._getAnkiNoteInfoForceValue(notes, true);
} catch (e) {
infos = this._getAnkiNoteInfoForceValue(notes, false);
ankiError = toError(e);
@@ -711,7 +747,6 @@ export class DisplayAnki {
modelName,
fields,
tags: this._noteTags,
- checkForDuplicates: this._checkForDuplicates,
duplicateScope: this._duplicateScope,
duplicateScopeCheckAllModels: this._duplicateScopeCheckAllModels,
resultOutputMode: this._resultOutputMode,
diff --git a/ext/js/input/hotkey-help-controller.js b/ext/js/input/hotkey-help-controller.js
index 16f3d26f..b495365d 100644
--- a/ext/js/input/hotkey-help-controller.js
+++ b/ext/js/input/hotkey-help-controller.js
@@ -181,4 +181,36 @@ export class HotkeyHelpController {
defaultAttributeValues
};
}
+
+ /**
+ * @param {HTMLElement} node
+ * @returns {?string}
+ */
+ getHotkeyLabel(node) {
+ const {hotkey} = node.dataset;
+ if (typeof hotkey !== 'string') { return null; }
+
+ const data = /** @type {unknown} */ (parseJson(hotkey));
+ if (!Array.isArray(data)) { return null; }
+
+ const values = /** @type {unknown[]} */ (data)[2];
+ if (typeof values !== 'string') { return null; }
+
+ return values;
+ }
+
+ /**
+ * @param {HTMLElement} node
+ * @param {string} label
+ */
+ setHotkeyLabel(node, label) {
+ const {hotkey} = node.dataset;
+ if (typeof hotkey !== 'string') { return; }
+
+ const data = /** @type {unknown} */ (parseJson(hotkey));
+ if (!Array.isArray(data)) { return; }
+
+ data[2] = label;
+ node.dataset.hotkey = JSON.stringify(data);
+ }
}