anki/ts/image-occlusion/lib.ts
Damien Elmes f6486da233
Various tweaks to I/O code (#2478)
* Allow user to select I/O notetype instead of enforcing a specific name

* Display a clearer error when I/O note is missing an image

Opening the card layout screen from "manage notetypes" was showing an
error about the Anki version being too old.

Replacement error is not currently translatable.

* Preserve existing notetype when adding I/O notetype

* Add a 'from clipboard' string

The intention is to use this in the future to allow an image occlusion
to be created from an image on the clipboard.

* Tweak I/O init

- Use union type instead of multiple nullable values
- Pass the notetype id in to initialization

* Fix image insertion in I/O note

- The regex expected double quotes, and we were using single ones
- Image tags don't need to be closed

* Use more consistent naming in image_occlusion.proto

* Tweaks to default I/O notetype

- Show the header on the front side as well (I presume this is what
users expect; if not am happy to revert)
- Don't show comments on card (again, I presume users expect to use
this field to add notes that aren't displayed during review, as they
can use back extra for that)

* Fix sticky footer missing background

Caused by earlier CSS refactoring
2023-04-19 15:30:18 +10:00

77 lines
1.9 KiB
TypeScript

// Copyright: Ankitects Pty Ltd and contributors
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
import type { Collection } from "../lib/proto";
import { ImageOcclusion, imageOcclusion } from "../lib/proto";
export interface IOAddingMode {
kind: "add";
notetypeId: number;
imagePath: string;
}
export interface IOEditingMode {
kind: "edit";
noteId: number;
}
export type IOMode = IOAddingMode | IOEditingMode;
export async function getImageForOcclusion(
path: string,
): Promise<ImageOcclusion.GetImageForOcclusionResponse> {
return imageOcclusion.getImageForOcclusion(
ImageOcclusion.GetImageForOcclusionRequest.create({
path,
}),
);
}
export async function addImageOcclusionNote(
notetypeId: number,
imagePath: string,
occlusions: string,
header: string,
backExtra: string,
tags: string[],
): Promise<Collection.OpChanges> {
return imageOcclusion.addImageOcclusionNote(
ImageOcclusion.AddImageOcclusionNoteRequest.create({
notetypeId,
imagePath,
occlusions,
header,
backExtra,
tags,
}),
);
}
export async function getImageOcclusionNote(
noteId: number,
): Promise<ImageOcclusion.GetImageOcclusionNoteResponse> {
return imageOcclusion.getImageOcclusionNote(
ImageOcclusion.GetImageOcclusionNoteRequest.create({
noteId,
}),
);
}
export async function updateImageOcclusionNote(
noteId: number,
occlusions: string,
header: string,
backExtra: string,
tags: string[],
): Promise<Collection.OpChanges> {
return imageOcclusion.updateImageOcclusionNote(
ImageOcclusion.UpdateImageOcclusionNoteRequest.create({
noteId,
occlusions,
header,
backExtra,
tags,
}),
);
}