backend and image occlusion proto for request

Author: krmanik

proto/anki/backend.proto

@@ -31,6 +31,7 @@ enum ServiceIndex {
   SERVICE_INDEX_LINKS = 15;
   SERVICE_INDEX_IMPORT_EXPORT = 16;
   SERVICE_INDEX_ANKIDROID = 17;
+  SERVICE_INDEX_IMAGE_OCCLUSION = 18;
 }
 
 message BackendInit {

proto/anki/image_occlusion.proto

@@ -0,0 +1,51 @@
+// Copyright: Ankitects Pty Ltd and contributors
+// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
+
+syntax = "proto3";
+
+option java_multiple_files = true;
+
+package anki.image_occlusion;
+
+import "anki/cards.proto";
+import "anki/collection.proto";
+import "anki/notes.proto";
+import "anki/generic.proto";
+
+service ImageOcclusionService {
+  rpc GetImageClozeMetadata(ImageClozeMetadataRequest) returns (ImageClozeMetadata);
+  rpc AddImageOcclusionNotes(AddImageOcclusionNotesRequest) returns (ResultAddNotes);
+}
+
+message ImageClozeMetadataRequest {
+  string path = 1;
+}
+
+message ImageClozeMetadata {
+  bytes data = 1;
+  string name = 2;
+  int64 deck_id = 3;
+
+  message MappedNotetype {
+    int64 id = 4;
+    // Source column indices for note fields. One-based. 0 means n/a.
+    repeated uint32 field_columns = 5;
+  }
+
+  oneof notetype {
+    // One notetype for all rows with given column mapping.
+    MappedNotetype global_notetype = 6;
+    // Row-specific notetypes with automatic mapping by index.
+    // One-based. 0 means n/a.
+    uint32 notetype_column = 7;
+  }
+}
+
+message AddImageOcclusionNotesRequest {
+  string image_path = 1;
+  bytes notes_data = 2;
+}
+
+message ResultAddNotes {
+  bool is_added = 1;
+}

pylib/anki/collection.py

@@ -11,6 +11,7 @@
     config_pb2,
     generic_pb2,
     import_export_pb2,
+    image_occlusion_pb2,
     links_pb2,
     search_pb2,
     stats_pb2,
@@ -38,6 +39,8 @@
 CsvMetadata = import_export_pb2.CsvMetadata
 DupeResolution = CsvMetadata.DupeResolution
 Delimiter = import_export_pb2.CsvMetadata.Delimiter
+ImageClozeMetadata = image_occlusion_pb2.ImageClozeMetadata
+AddImageOcclusionNotesRequest = image_occlusion_pb2.AddImageOcclusionNotesRequest
 
 import copy
 import os
@@ -454,6 +457,15 @@ def import_json_file(self, path: str) -> ImportLogWithChanges:
     def import_json_string(self, json: str) -> ImportLogWithChanges:
         return self._backend.import_json_string(json)
 
+    # Image Occlusion
+    def get_image_cloze_metadata(self, path: str | None) -> ImageClozeMetadata:
+        request = image_occlusion_pb2.ImageClozeMetadataRequest(path=path)
+        return self._backend.get_image_cloze_metadata(request)
+
+    def add_image_occlusion_notes(self, image_path: str | None, notes_data: bytes | None) -> bool:
+        request = image_occlusion_pb2.AddImageOcclusionNotesRequest(image_path=image_path, notes_data=notes_data)
+        return self._backend.add_image_occlusion_notes(request)
+
     # Object helpers
     ##########################################################################
 

pylib/tools/genbackend.py

@@ -20,6 +20,7 @@
 import anki.decks_pb2
 import anki.i18n_pb2
 import anki.import_export_pb2
+import anki.image_occlusion_pb2
 import anki.links_pb2
 import anki.media_pb2
 import anki.notes_pb2
@@ -187,6 +188,7 @@ def render_service(
     MEDIA=anki.media_pb2,
     LINKS=anki.links_pb2,
     IMPORT_EXPORT=anki.import_export_pb2,
+    IMAGE_OCCLUSION=anki.image_occlusion_pb2,
 )
 
 for service in anki.backend_pb2.ServiceIndex.DESCRIPTOR.values:
@@ -238,6 +240,7 @@ def render_service(
 import anki.tags_pb2
 import anki.media_pb2
 import anki.import_export_pb2
+import anki.image_occlusion_pb2
 
 class RustBackendGenerated:
     def _run_command(self, service: int, method: int, input: Any) -> bytes:

ts/lib/proto.ts

@@ -15,6 +15,7 @@ import DeckConfig = anki.deckconfig;
 import Decks = anki.decks;
 import Generic = anki.generic;
 import I18n = anki.i18n;
+import ImageOcclusion = anki.image_occlusion;
 import ImportExport = anki.import_export;
 import Notes = anki.notes;
 import Notetypes = anki.notetypes;
@@ -81,3 +82,6 @@ export const stats = Stats.StatsService.create(serviceCallback as RPCImpl);
 
 export { Tags };
 export const tags = Tags.TagsService.create(serviceCallback as RPCImpl);
+
+export { ImageOcclusion };
+export const imageOcclusion = ImageOcclusion.ImageOcclusionService.create(serviceCallback as RPCImpl);