@opengis/gis 0.2.151 → 0.2.154

package/server/plugins/mapnik/map.proto

@@ -1,230 +1,305 @@
-syntax = "proto3";
-
-import "google/protobuf/struct.proto"; // after syntax!
-
-package map;
-
-// ----------------------------
-// Map Service
-// ----------------------------
-service MapService {
-    rpc RenderTile(RenderTileRequest) returns (RenderTileOut);
-    rpc ClearTile(ClearTileRequest) returns (ClearTileOut);
-    rpc ReadDir(ReadDirRequest) returns (ReadDirOut);
-    rpc FileStat(FileStatRequest) returns (FileStatOut);
-    rpc FileSearch(FileSearchRequest) returns (FileSearchOut);
-    rpc CreateXML(CreateXMLRequest) returns (stream JobProgress); // streaming XML creation
-    rpc UploadXML(UploadXMLRequest) returns (UploadXMLOut);
-    rpc UploadRaster(UploadRasterRequest) returns (UploadRasterOut);
-    rpc GetRasterStatus(GetRasterStatusRequest) returns (GetStatusOut);
-    rpc GetStat(GetStatRequest) returns (GetStatOut);
-    rpc GetRender(GetRenderRequest) returns (GetRenderOut);
-    rpc GetLogs(GetLogsRequest) returns (GetLogsOut);
-    rpc GetRasterInfo(GetRasterInfoRequest) returns (GetRasterInfoOut);
-}
-
-// ----------------------------
-// Messages for MapService
-// ----------------------------
-message RenderTileRequest {
-    string name = 1;
-    string path = 2;
-    repeated double bbox = 3;  // [minx, miny, maxx, maxy]
-    int32 width = 4;
-    string ttl = 5; // "5m", "1h", "1d" or "0"
-    string debug = 6;
-}
-
-message RenderTileOut {
-    string base64 = 1;
-    bool cache = 2;
-    string err = 3;
-    string xml_path = 4;
-    string tile_path = 5;
-}
-
-message ClearTileRequest {
-    string name = 1;
-    string path = 2;
-}
-
-message ClearTileOut {
-    string result = 1;
-    string err = 2;
-}
-
-message FileStatRequest {
-    string path = 1;
-}
-
-message FileStatOut {
-    bool exists = 1;
-    string name = 2;
-    int64 size = 3;
-    string adate = 4;
-    string cdate = 5;
-    string mdate = 6;
-}
-
-message FileSearchRequest {
-    string path = 1;
-    string key = 2;
-    string period = 3;
-    int64 size = 4;
-}
-
-message FileSearchOut {
-    bool exists = 1;
-    int32 count = 2;
-    repeated FileInfo files = 3;
-    repeated DirInfo directories = 4;
-}
-
-message ReadDirRequest {
-    string path = 1;
-}
-
-message FileInfo {
-    string name = 1;
-    int64 size = 2;
-    string date = 3;
-    string dir = 4;
-}
-
-message DirInfo {
-    string name = 1;
-    int64 size = 2;
-    string date = 3;
-    int64 children = 4;
-}
-
-message ReadDirOut {
-    bool exists = 1;
-    int32 count = 2;
-    repeated FileInfo files = 3;
-    repeated DirInfo directories = 4;
-}
-
-message CreateXMLRequest {
-    string path = 1;
-    int32 srid = 2;
-    int32 previewZoom = 3;
-    repeated string layers = 4;
-    bool vrt = 5;
-    string name = 6;
-    string debug = 7;
-    string nocache = 8;
-    string proj4 = 9;
-}
-
-message UploadXMLRequest {
-    string name = 1;
-    string xml = 2;
-    string encoding = 3;
-    string path = 4;
-}
-
-message UploadXMLOut {
-    string status = 1;
-    string filepath = 2;
-}
-
-message UploadRasterRequest {
-    string path = 1;
-    bytes data = 2;
-    bool chunked = 3;
-    int64 filesize = 4;
-}
-
-message UploadRasterOut {
-    string status = 1;
-    int64 uploaded = 2;
-    bool finished = 3;
-}
-
-message GetRasterStatusRequest {
-    string path = 1;
-    bool md5 = 2;
-}
-
-message GetStatusOut {
-  bool exists = 1;
-  string size = 2;
-  bool finished = 3;
-}
-
-message GetStatRequest {
-    string period = 1;  // "5m", "1h", "1d"
-}
-
-message GetStatOut {
-    google.protobuf.Struct result = 1; // dynamic json structure, not bound by same value type like with map
-}
-
-message GetRenderRequest {
-    string name = 1;
-    string path = 2;
-}
-
-message GetRenderOut {
-    string result = 1;  // serialized object or placeholder
-}
-
-message GetLogsRequest {
-    string path = 1;  // "info", "info/2026-01-01.log" etc.
-}
-
-message GetLogsOut {
-    string data = 1;
-    string links = 2;
-    string err = 3;
-}
-
-message GetRasterInfoRequest {
-    string path = 1;
-    int64 srid = 3;
-    string proj4 = 4;
-}
-
-message FileItem {
-  string name = 1;
-  string size = 2;
-}
-
-message GetRasterInfoData {
-    string total_size = 1;
-    string extension = 2;
-    int64 srid = 3;
-    string proj4 = 4;
-    repeated float extent = 5;
-    repeated FileItem files = 6;
-    int64 width = 7;
-    int64 height = 8;
-    int64 bands_count = 9;
-    string resolution = 10;
-    repeated string bands = 11;
-    int64 color_depth = 12;
-    string compression = 13;
-    bool xml = 14;
-}
-
-message GetRasterInfoOut {
-    GetRasterInfoData data = 1;
-    bool cache = 2;
-}
-
-// ----------------------------
-// Job Service Messages
-// ----------------------------
-message JobRequest {
-    string job_id = 1;
-    string xml_name = 2;
-    string xml_path = 3;
-    repeated string layers = 4;
-}
-
-message JobProgress {
-    string message = 1;
-    string error = 2;
-    bool done = 3;
-}
+syntax = "proto3";
+
+import "google/protobuf/struct.proto"; // after syntax!
+
+package map;
+
+// ----------------------------
+// Map Service
+// ----------------------------
+service MapService {
+    rpc RenderTile(RenderTileRequest) returns (RenderTileOut);
+    rpc ClearTile(ClearTileRequest) returns (ClearTileOut);
+    rpc ReadDir(ReadDirRequest) returns (ReadDirOut);
+    rpc FileStat(FileStatRequest) returns (FileStatOut);
+    rpc FileSearch(FileSearchRequest) returns (FileSearchOut);
+    rpc CreateXML(CreateXMLRequest) returns (stream JobProgress); // streaming XML creation
+    rpc CreateIndex(CreateIndexRequest) returns (CreateIndexOut); // create/update index.geojson for folder
+    rpc ConvertLog(ConvertLogRequest) returns (ConvertLogOut); // json state for current stream tasks
+    rpc ConvertCog(ConvertCogRequest) returns (stream JobProgress); // streaming COG conversion
+    rpc ImportData(ImportDataRequest) returns (stream JobProgress); // streaming SHP -> PostGIS import
+    rpc UploadXML(UploadXMLRequest) returns (UploadXMLOut);
+    rpc UploadRaster(UploadRasterRequest) returns (UploadRasterOut);
+    rpc GetRasterStatus(GetRasterStatusRequest) returns (GetStatusOut);
+    rpc GetStat(GetStatRequest) returns (GetStatOut);
+    rpc GetLogs(GetLogsRequest) returns (GetLogsOut);
+    rpc GetRasterInfo(GetRasterInfoRequest) returns (GetRasterInfoOut);
+    rpc GetMeta(GetMetaRequest) returns (GetMetaOut);
+}
+
+// ----------------------------
+// Messages for MapService
+// ----------------------------
+message RenderTileRequest {
+    string name = 1;
+    string path = 2;
+    repeated double bbox = 3;  // [minx, miny, maxx, maxy]
+    int32 width = 4;
+    string ttl = 5; // "5m", "1h", "1d" or "0"
+    string debug = 6;
+    optional int32 z = 7; // optional XYZ tile zoom
+    optional int32 x = 8; // optional XYZ tile x
+    optional int32 y = 9; // optional XYZ tile y
+    bool meta = 10; // when true return tile metadata/path only (without base64 image payload)
+    optional bool base64 = 11; // optional output mode flag: true -> base64, false -> raw bytes
+}
+
+message RenderTileOut {
+    string base64 = 1;
+    bool cache = 2;
+    string err = 3;
+    string xml_path = 4;
+    string tile_path = 5;
+    string tile_url = 6;
+    bytes data = 7; // raw PNG bytes (used when request.base64=false)
+}
+
+message ClearTileRequest {
+    string name = 1;
+    string path = 2;
+}
+
+message ClearTileOut {
+    string result = 1;
+    string err = 2;
+}
+
+message FileStatRequest {
+    string path = 1;
+}
+
+message FileStatOut {
+    bool exists = 1;
+    string name = 2;
+    int64 size = 3;
+    string adate = 4;
+    string cdate = 5;
+    string mdate = 6;
+}
+
+message FileSearchRequest {
+    string path = 1;
+    string key = 2;
+    string period = 3;
+    int64 size = 4;
+}
+
+message FileSearchOut {
+    bool exists = 1;
+    int32 count = 2;
+    repeated FileInfo files = 3;
+    repeated DirInfo directories = 4;
+}
+
+message ReadDirRequest {
+    string path = 1;
+}
+
+message FileInfo {
+    string name = 1;
+    int64 size = 2;
+    string date = 3;
+    string dir = 4;
+    optional bool cog = 5; // COG flag for TIFF files
+}
+
+message DirInfo {
+    string name = 1;
+    int64 size = 2;
+    string date = 3;
+    int64 children = 4;
+}
+
+message ReadDirOut {
+    bool exists = 1;
+    int32 count = 2;
+    repeated FileInfo files = 3;
+    repeated DirInfo directories = 4;
+}
+
+message CreateXMLRequest {
+    string path = 1;
+    int32 srid = 2;
+    int32 previewZoom = 3;
+    repeated string layers = 4;
+    bool vrt = 5;
+    string name = 6;
+    string debug = 7;
+    string nocache = 8;
+    string proj4 = 9;
+    bool cog = 10; // enable COG pipeline and map.xml without preview/zoom split
+    bool preview = 11; // build preview and include preview layer in XML
+    bool recursive = 12; // recursive source scan for folder targets
+    string compress = 13; // COG compression mode: AUTO|DEFLATE|ZSTD|LZW|JPEG
+    bool recompress = 14; // allow re-converting files that are already COG
+    int32 quality = 15; // JPEG quality (1..100), 0 means default 85
+    bool single = 16; // when path is folder, create one XML per raster file
+    string mode = 17; // folder mode: auto|single|multi (replaces legacy single=true)
+    int32 minZoom = 18; // minzoom value for map.xml Parameters (default: 10)
+    reserved 19, 20, 21, 22, 27;
+    reserved "vrtResample", "vrtResolution", "vrtXRes", "vrtYRes", "vrtTap";
+    string vrtSrcNodata = 23; // source nodata value(s), e.g. "0" or "0 0 0"
+    string vrtNodata = 24; // VRT nodata value(s)
+    bool vrtHideNodata = 25; // hide nodata in VRT
+    bool vrtAddAlpha = 26; // add alpha band in VRT
+    bool overwrite = 28; // overwrite existing xml when true
+}
+
+message CreateIndexRequest {
+    string path = 1; // folder path under raster root
+    bool recursive = 2; // include nested folders
+    bool overwrite = 3; // recreate existing index.geojson
+}
+
+message CreateIndexOut {
+    string path = 1; // relative index.geojson path
+    bool created = 2; // true when index.geojson written in this call
+    bool skipped = 3; // true when existing index.geojson kept as-is
+    bool overwritten = 4; // true when existing index.geojson was replaced
+    int32 source_count = 5; // discovered source TIFF count
+    int32 feature_count = 6; // written feature count
+    int32 skipped_sources_count = 7; // sources skipped due unreadable/missing geometry
+}
+
+message ConvertLogRequest {
+    string path = 1; // optional filter by request path
+    string method = 2; // optional filter by method (CreateXML|ConvertCog)
+}
+
+message ConvertLogOut {
+    string data = 1; // json payload with current stream tasks
+    string stat_path = 2; // relative path to stat file: log/stream/stat/[date].log
+    string err = 3; // error text when failed
+}
+
+message ConvertCogRequest {
+    string name = 1; // deprecated fallback: file name only
+    string path = 2; // raster file or folder
+    bool recursive = 3; // process nested folders when path is directory
+    string compress = 4; // COG compression mode: AUTO|DEFLATE|ZSTD|LZW|JPEG
+    bool recompress = 5; // allow re-converting files that are already COG
+    int32 quality = 6; // JPEG quality (1..100), 0 means default 85
+    int32 srid = 7; // optional target SRID for reprojection before COG conversion
+}
+
+message ImportDataRequest {
+    string path = 1; // path to .shp file or directory under vector root
+    bool recursive = 2; // process nested folders when path is directory
+    bool force = 3; // overwrite existing tables when true
+}
+
+message UploadXMLRequest {
+    string name = 1;
+    string xml = 2;
+    string encoding = 3;
+    string path = 4;
+}
+
+message UploadXMLOut {
+    string status = 1;
+    string filepath = 2;
+}
+
+message UploadRasterRequest {
+    string path = 1;
+    bytes data = 2;
+    bool chunked = 3;
+    int64 filesize = 4;
+}
+
+message UploadRasterOut {
+    string status = 1;
+    int64 uploaded = 2;
+    bool finished = 3;
+}
+
+message GetRasterStatusRequest {
+    string path = 1;
+    bool md5 = 2;
+}
+
+message GetStatusOut {
+  bool exists = 1;
+  string size = 2;
+  bool finished = 3;
+}
+
+message GetStatRequest {
+    string period = 1;  // "5m", "1h", "1d"
+}
+
+message GetStatOut {
+    google.protobuf.Struct result = 1; // dynamic json structure, not bound by same value type like with map
+}
+
+message GetLogsRequest {
+    string path = 1;  // "info", "info/2026-01-01.log" etc.
+}
+
+message GetLogsOut {
+    string data = 1;
+    string links = 2;
+    string err = 3;
+}
+
+message GetRasterInfoRequest {
+    string path = 1;
+    int64 srid = 3;
+    string proj4 = 4;
+}
+
+message FileItem {
+  string name = 1;
+  string size = 2;
+}
+
+message GetRasterInfoData {
+    string total_size = 1;
+    string extension = 2;
+    int64 srid = 3;
+    string proj4 = 4;
+    repeated float extent = 5;
+    repeated FileItem files = 6;
+    int64 width = 7;
+    int64 height = 8;
+    int64 bands_count = 9;
+    string resolution = 10;
+    repeated string bands = 11;
+    int64 color_depth = 12;
+    string compression = 13;
+    bool xml = 14;
+    optional bool cog = 15;
+}
+
+message GetRasterInfoOut {
+    GetRasterInfoData data = 1;
+    bool cache = 2;
+}
+
+message GetMetaRequest {
+    string path = 1;
+    repeated double bbox = 2; // optional [minx, miny, maxx, maxy]
+}
+
+message GetMetaOut {
+    google.protobuf.Struct data = 1; // raw metadata JSON
+    bool cache = 2; // true when metadata file already existed
+    string meta_path = 3; // relative metadata file path
+    bool bbox_intersects = 4; // bbox vs metadata extent (true when bbox absent)
+}
+
+// ----------------------------
+// Job Service Messages
+// ----------------------------
+message JobRequest {
+    string job_id = 1;
+    string xml_name = 2;
+    string xml_path = 3;
+    repeated string layers = 4;
+}
+
+message JobProgress {
+    string message = 1;
+    string error = 2;
+    bool done = 3;
+}