Add token refresh and Argon2 secret key support

src/client/plantdb/client/api_endpoints.py

@@ -21,9 +21,10 @@
 >>> api_endpoints.scan('plant1', prefix='/api/v1')
 '/api/v1/scans/plant1'
 """
+from urllib import parse
 
 
-def sanitize_name(name):
+def sanitize_name(name) -> str:
     """Sanitizes and validates the provided name.
 
     The function ensures that the input string adheres to predefined naming rules by:
@@ -58,9 +59,8 @@ def sanitize_name(name):
     return sanitized_name
 
 
-def url_prefix(endpoint_path):
-    """
-    Wrap an endpoint path generator with an optional URL prefix.
+def url_prefix(endpoint_path) :
+    """Wrap an endpoint path generator with an optional URL prefix.
 
     Examples
     --------
@@ -282,6 +282,29 @@ def scans(**kwargs) -> str:
     return "/scans"
 
 
+@url_prefix
+def scans_info(**kwargs) -> str:
+    """Return the URL path to the list of scan dataset information endpoint.
+
+    Other Parameters
+    ----------------
+    prefix : str
+        An optional prefix to prepend to the URL path.
+
+    Returns
+    -------
+    str
+        The URL path to the list of scan dataset information endpoint.
+
+    Examples
+    --------
+    >>> from plantdb.client import api_endpoints
+    >>> api_endpoints.scans_info(prefix='/api/v1')
+    '/api/v1/scans_info'
+    """
+    return "/scans_info"
+
+
 @url_prefix
 def scan(scan_id: str, **kwargs) -> str:
     """Return the URL path to the scan endpoint.
@@ -313,7 +336,7 @@ def scan(scan_id: str, **kwargs) -> str:
 
 
 @url_prefix
-def image(scan_id: str, fileset_id: str, file_id: str, size: str, **kwargs) -> str:
+def image(scan_id: str, fileset_id: str, file_id: str, size: str, as_base64:bool, **kwargs) -> str:
     """Return the URL path to the image endpoint.
 
     Parameters
@@ -326,6 +349,8 @@ def image(scan_id: str, fileset_id: str, file_id: str, size: str, **kwargs) -> s
         The name of the image.
     size : str or int
         The size parameter of the image request.
+    as_base64 : bool
+        A boolean flag indicating whether to return an image as a base64 string.
 
     Returns
     -------
@@ -335,13 +360,25 @@ def image(scan_id: str, fileset_id: str, file_id: str, size: str, **kwargs) -> s
     Examples
     --------
     >>> from plantdb.client import api_endpoints
-    >>> api_endpoints.image('real_plant','images','00000_rgb', 'orig')
+    >>> api_endpoints.image('real_plant','images','00000_rgb', 'orig', False)
     '/image/real_plant/images/00000_rgb?size=orig'
+    >>> api_endpoints.image('real_plant','images','00000_rgb', 'thumb', True)
+    '/image/real_plant/images/00000_rgb?size=thumb&as_base64=true'
     """
     scan_id = sanitize_name(scan_id)
     fileset_id = sanitize_name(fileset_id)
     file_id = sanitize_name(file_id)
-    return f"/image/{scan_id}/{fileset_id}/{file_id}?size={size}"
+
+    # Assemble optional query parameters
+    query: dict[str, str] = {}
+    if size is not None:
+        query["size"] = str(size)
+    if as_base64 is not None:
+        # Use lower‑case JSON‑style booleans for consistency
+        query["as_base64"] = str(as_base64).lower()
+
+    query_str = f"?{parse.urlencode(query)}" if query else ""
+    return f"/image/{scan_id}/{fileset_id}/{file_id}{query_str}"
 
 
 @url_prefix
@@ -370,7 +407,14 @@ def sequence(scan_id: str, type: str, **kwargs) -> str:
     valid_types = ['all', 'angles', 'internodes', 'fruit_points', 'manual_angles', 'manual_internodes']
     type = 'all' if type not in valid_types else type
     scan_id = sanitize_name(scan_id)
-    return f"/sequence/{scan_id}?type={type}"
+
+    # Assemble optional query parameters
+    query: dict[str, str] = {}
+    if type is not None:
+        query["type"] = str(type)
+
+    query_str = f"?{parse.urlencode(query)}" if query else ""
+    return f"/sequence/{scan_id}{query_str}"
 
 
 @url_prefix
@@ -453,9 +497,8 @@ def scan_file(scan_id: str, file_path: str, **kwargs) -> str:
     return f"/files/{scan_id}/{file_path.lstrip('/')}"
 
 
-
 @url_prefix
-def create_user(**kwargs):
+def create_user(**kwargs) -> str:
     """Create the user registration URL.
 
     Returns
@@ -470,3 +513,108 @@ def create_user(**kwargs):
     '/register'
     """
     return f"/register"
+
+
+@url_prefix
+def create_scan(**kwargs) -> str:
+    """URL to create a scan.
+
+    Returns
+    -------
+    str
+        The URL path to scan creation.
+    """
+    return f"/api/scan"
+
+
+@url_prefix
+def create_fileset(**kwargs) -> str:
+    """URL to create a fileset.
+
+    Returns
+    -------
+    str
+        The URL path to fileset creation.
+    """
+    return f"/api/fileset"
+
+
+@url_prefix
+def create_file(**kwargs) -> str:
+    """URL to create a file.
+
+    Returns
+    -------
+    str
+        The URL path to file creation.
+    """
+    return f"/api/file"
+
+
+@url_prefix
+def list_scan_filesets(scan: str, **kwargs) -> str:
+    """URL to list the filesets associated with the given scan name.
+
+    Returns
+    -------
+    str
+        The URL path to filesets.
+    """
+    scan_id = sanitize_name(scan)
+    return f"/api/scan/{scan_id}/filesets"
+
+
+@url_prefix
+def list_fileset_files(scan: str, fileset: str, **kwargs) -> str:
+    """URL to list the file associated with the given scan and filesets names.
+
+    Returns
+    -------
+    str
+        The URL path to filesets.
+    """
+    scan_id = sanitize_name(scan)
+    fileset = sanitize_name(fileset)
+    return f"/api/scan/{scan_id}/{fileset}/files"
+
+
+@url_prefix
+def metadata_scan(scan: str, **kwargs) -> str:
+    """URL to access the metadata associated with the given scan name.
+
+    Returns
+    -------
+    str
+        The URL path to scan metadata.
+    """
+    scan_id = sanitize_name(scan)
+    return f"/api/scan/{scan_id}/metadata"
+
+
+@url_prefix
+def metadata_fileset(scan: str, fileset: str, **kwargs) -> str:
+    """URL to access the fileset metadata associated with the given scan and fileset name.
+
+    Returns
+    -------
+    str
+        The URL path to fileset metadata.
+    """
+    scan_id = sanitize_name(scan)
+    fileset = sanitize_name(fileset)
+    return f"/api/scan/{scan_id}/{fileset}/metadata"
+
+
+@url_prefix
+def metadata_files(scan: str, fileset: str, file: str, **kwargs) -> str:
+    """URL to access the file metadata associated with the given scan and fileset name.
+
+    Returns
+    -------
+    str
+        The URL path to file metadata.
+    """
+    scan_id = sanitize_name(scan)
+    fileset = sanitize_name(fileset)
+    file = sanitize_name(file)
+    return f"/api/scan/{scan_id}/{fileset}/{file}/metadata"

src/client/plantdb/client/cli/fsdb_rest_api_sync.py

@@ -197,7 +197,7 @@ def sync_scan_archives(origin_url, target_url, filter_pattern=None, log_level=DE
         Path(f_path).unlink()
         # Refresh the scan in the target to load its infos:
         try:
-            msg = request_refresh(scan_id, host=target_host, port=target_port)
+            success, msg = request_refresh(scan_id, host=target_host, port=target_port)
         except HTTPError as e:
             logger.error(f"Error refreshing target database for scan '{scan_id}': {e}")
             continue