configuration.ts

import type {
    FilterDistanceConfig,
    ConfidenceSliderConfig,
    ImageFiltersConfig,
    InitialCrop,
    ImageData,
    RecolorActiveConfig,
    ULabelSubmitButton,
    AnnoScalingMode,
    BrushOverlapMode,
} from "../index";
import {
    ModeSelectionToolboxItem,
    ZoomPanToolboxItem,
    AnnotationIDToolboxItem,
    ClassCounterToolboxItem,
    AnnotationResizeItem,
    RecolorActiveItem,
    FilterPointDistanceFromRow,
    BrushToolboxItem,
    ToolboxItem,
} from "./toolbox";
import { ConfidenceSlider, KeypointSliderItem } from "./toolbox_items/confidence_slider";
import { SubmitButtons } from "./toolbox_items/submit_buttons";
import { ImageFiltersToolboxItem } from "./toolbox_items/image_filters";
import { AnnotationListToolboxItem } from "./toolbox_items/annotation_list";
import { KeybindsToolboxItem } from "./toolbox_items/keybinds";
import { is_object_and_not_array } from "./utilities";

/* eslint-disable @stylistic/no-multi-spaces */
export enum AllowedToolboxItem {
    ModeSelect,       // 0
    ZoomPan,          // 1
    AnnotationResize, // 2
    AnnotationID,     // 3
    RecolorActive,    // 4
    ClassCounter,     // 5
    KeypointSlider,   // 6
    SubmitButtons,    // 7
    FilterDistance,   // 8
    Brush,            // 9
    ImageFilters,     // 10
    AnnotationList,   // 11
    Keybinds,         // 12
    ConfidenceSlider, // 13
}
/* eslint-enable @stylistic/no-multi-spaces */

export const DEFAULT_N_ANNOS_PER_CANVAS: number = 100;
export const TARGET_MAX_N_CANVASES_PER_SUBTASK: number = 8;
export const DEFAULT_FILTER_DISTANCE_CONFIG: FilterDistanceConfig = {
    name: "Filter Distance From Row",
    component_name: "filter-distance-from-row",
    filter_min: 0,
    filter_max: 400,
    default_values: { closest_row: { distance: 40 } },
    step_value: 2,
    multi_class_mode: false,
    disable_multi_class_mode: false,
    filter_on_load: true,
    show_options: true,
    show_overlay: false,
    toggle_overlay_keybind: "p",
    filter_during_polyline_move: true,
};

export const DEFAULT_CONFIDENCE_SLIDER_CONFIG: ConfidenceSliderConfig = {
    name: "Confidence Filter",
    filter_min: 0,
    filter_max: 100,
    default_values: { all: 0 },
    step_value: 1,
    class_filter_mode: "toggle",
    filter_on_load: true,
};

export const DEFAULT_IMAGE_FILTERS_CONFIG: ImageFiltersConfig = {
    default_values: {
        brightness: 100,
        contrast: 100,
        hueRotate: 0,
        invert: 0,
        saturate: 100,
    },
};

export class Configuration {
    // Index signature to allow string indexing for dynamic property access
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    [key: string]: any;
    /**
     * Dynamically get all keybind configuration property names.
     * Scans the Configuration class for properties ending in "_keybind" or known keybind properties.
     * Use this to iterate over keybind properties without maintaining a hardcoded list.
     */
    public static get KEYBIND_CONFIG_KEYS(): readonly string[] {
        // Get all properties from a Configuration instance
        const config = new Configuration();
        const keybind_keys: string[] = [];

        for (const key in config) {
            // Include all properties ending with "_keybind"
            if (key.endsWith("_keybind")) {
                // Verify it's a string property (keybinds should be strings)
                if (typeof config[key] === "string") {
                    keybind_keys.push(key);
                }
            }
        }

        return keybind_keys;
    }

    // Values useful for generating HTML for tool
    public container_id: string = "container";
    public px_per_px: number = 1;
    public anno_scaling_mode: AnnoScalingMode = "fixed";
    public initial_crop: InitialCrop | null = null;
    public annbox_id: string = "annbox";
    public imwrap_id: string = "imwrap";
    public canvas_fid_pfx: string = "front-canvas";
    public canvas_bid_pfx: string = "back-canvas";
    public canvas_did: string = "demo-canvas";
    public canvas_class: string = "easel";
    public image_id_pfx: string = "ann_image";
    public imgsz_class: string = "imgsz";
    public toolbox_id: string = "toolbox";

    // Dimensions of various components of the tool
    public image_width: number | null = null;
    public image_height: number | null = null;
    public demo_width: number = 120;
    public demo_height: number = 40;
    public polygon_ender_size: number = 15;
    public edit_handle_size: number = 30;
    public brush_size: number = 60;

    // Fill opacity (0-1) used when rendering bitmask (raster segmentation) annotations
    public mask_annotation_opacity: number = 0.4;
    // How the bitmask brush resolves overlap with other undeprecated bitmask
    // annotations when painting. Resolution is deferred to the end of a stroke.
    // The live value is global and persisted to localStorage; this is the initial default.
    public default_brush_overlap_mode: BrushOverlapMode = "none";
    public brush_overlap_mode: BrushOverlapMode = "none";
    // Configuration for the annotation task itself
    public image_data: ImageData | null = null;
    public allow_soft_id: boolean = false;
    public default_annotation_color: string = "#fa9d2a";
    public username: string = "ULabelUser";
    public initial_line_size: number = 5;

    // ID Dialog config
    public cl_opacity: number = 0.4;
    public outer_diameter: number = 200;
    public inner_prop: number = 0.3;

    // Behavior on special interactions
    public instructions_url: string | null = null;
    public submit_buttons: ULabelSubmitButton[] = [];

    // Passthrough
    public task_meta: object = {};
    public annotation_meta: object = {};

    public subtasks: object | null = null;

    /**
     * Map from AllowedToolboxItem enum to the class that implements it.
     * The typing here uses a
     * [abstract construct signature](https://www.typescriptlang.org/docs/handbook/2/classes.html#abstract-construct-signatures)
     * to handle the different constructors for each toolbox item.
     */
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    public toolbox_map = new Map<AllowedToolboxItem, new (..._: any[]) => ToolboxItem>([
        [AllowedToolboxItem.ModeSelect, ModeSelectionToolboxItem],
        [AllowedToolboxItem.ZoomPan, ZoomPanToolboxItem],
        [AllowedToolboxItem.AnnotationResize, AnnotationResizeItem],
        [AllowedToolboxItem.AnnotationID, AnnotationIDToolboxItem],
        [AllowedToolboxItem.RecolorActive, RecolorActiveItem],
        [AllowedToolboxItem.ClassCounter, ClassCounterToolboxItem],
        [AllowedToolboxItem.KeypointSlider, KeypointSliderItem],
        [AllowedToolboxItem.SubmitButtons, SubmitButtons],
        [AllowedToolboxItem.FilterDistance, FilterPointDistanceFromRow],
        [AllowedToolboxItem.Brush, BrushToolboxItem],
        [AllowedToolboxItem.ImageFilters, ImageFiltersToolboxItem],
        [AllowedToolboxItem.AnnotationList, AnnotationListToolboxItem],
        [AllowedToolboxItem.Keybinds, KeybindsToolboxItem],
        [AllowedToolboxItem.ConfidenceSlider, ConfidenceSlider],
    ]);

    // Default toolbox order used when the user doesn't specify one
    public toolbox_order: AllowedToolboxItem[] = [
        AllowedToolboxItem.Keybinds,
        AllowedToolboxItem.ModeSelect,
        AllowedToolboxItem.AnnotationList,
        AllowedToolboxItem.Brush,
        AllowedToolboxItem.ImageFilters,
        AllowedToolboxItem.ZoomPan,
        AllowedToolboxItem.AnnotationResize,
        AllowedToolboxItem.AnnotationID,
        AllowedToolboxItem.RecolorActive,
        AllowedToolboxItem.ClassCounter,
        AllowedToolboxItem.ConfidenceSlider,
        AllowedToolboxItem.SubmitButtons,
    ];

    // Config for RecolorActiveItem
    public recolor_active_toolbox_item: RecolorActiveConfig = {
        gradient_turned_on: false,
    };

    // Config for FilterDistanceToolboxItem
    public distance_filter_toolbox_item: FilterDistanceConfig = DEFAULT_FILTER_DISTANCE_CONFIG;

    // Config for ConfidenceSlider
    public confidence_slider_toolbox_item: ConfidenceSliderConfig = DEFAULT_CONFIDENCE_SLIDER_CONFIG;

    // Config for ImageFiltersToolboxItem
    public image_filters_toolbox_item: ImageFiltersConfig = DEFAULT_IMAGE_FILTERS_CONFIG;

    public reset_zoom_keybind: string = "r";

    public show_full_image_keybind: string = "shift+r";

    public create_point_annotation_keybind: string = "c";

    public delete_annotation_keybind: string = "d";

    public delete_vertex_keybind: string = "x";

    public keypoint_slider_default_value: number = 0;

    public filter_annotations_on_load: boolean = true;

    public switch_subtask_keybind: string = "z";

    public toggle_annotation_mode_keybind: string = "u";

    public create_bbox_on_initial_crop_keybind: string = "f";

    public toggle_brush_mode_keybind: string = "g";

    public toggle_erase_mode_keybind: string = "e";

    public increase_brush_size_keybind: string = "]";

    public decrease_brush_size_keybind: string = "[";

    public set_brush_overlap_none_keybind: string = "shift+n";

    public set_brush_overlap_exclude_keybind: string = "shift+e";

    public set_brush_overlap_overwrite_keybind: string = "shift+o";

    public annotation_size_small_keybind: string = "s";

    public annotation_size_large_keybind: string = "l";

    public annotation_size_plus_keybind: string = "=";

    public annotation_size_minus_keybind: string = "-";

    public annotation_vanish_keybind: string = "v";

    public annotation_vanish_all_keybind: string = "shift+v";

    public fly_to_next_annotation_keybind: string = "tab";

    public fly_to_previous_annotation_keybind: string = "shift+tab";

    public fly_to_max_zoom: number = 10;

    public n_annos_per_canvas: number = DEFAULT_N_ANNOS_PER_CANVAS;

    public click_and_drag_poly_annotations: boolean = true;

    public allow_annotations_outside_image: boolean = true;

    public auto_destroy_on_detach: boolean = true;

    constructor(...kwargs: { [key: string]: unknown }[]) {
        this.modify_config(...kwargs);
    }

    // TODO (joshua-dean): Can this any be narrowed?
    // eslint-disable-next-line @typescript-eslint/no-explicit-any
    public modify_config(...kwargs: { [key: string]: any }[]) {
        // Loop through every elements in kwargs
        for (let idx = 0; idx < kwargs.length; idx++) {
            // For every key: value pair, overwrite them/add them to the config
            for (const key in kwargs[idx]) {
                // If the value itself is an object, then loop through it and modify only the defined values
                if (
                    is_object_and_not_array(kwargs[idx][key]) &&
                    is_object_and_not_array(this[key])
                ) {
                    const inner_object = kwargs[idx][key];
                    for (const inner_key in inner_object) {
                        this[key][inner_key] = inner_object[inner_key];
                    }
                } else {
                    this[key] = kwargs[idx][key];
                }
            }
        }
    }
}