/*
 * This file belongs to Hoist, an application development toolkit
 * developed by Extremely Heavy Industries (www.xh.io | info@xh.io)
 *
 * Copyright © 2026 Extremely Heavy Industries Inc.
 */
import {BaseFieldConfig} from '@xh/hoist/cmp/form/field/BaseFieldModel';
import {XH, AppOptionSpec} from '@xh/hoist/core';
import {warnIf} from '@xh/hoist/utils/js';
import {isFunction} from 'lodash';

/**
 * Options specification for the app-wide options dialog.
 *
 * Option can be sourced from / set to a preference via the `prefName` config. Alternatively,
 * the `valueGetter` and `valueSetter` config functions allow for custom handling if required.
 *
 * Apps will typically specify AppOption configurations in HoistAppModel.getAppOptions(). Implement
 * this method and return one or more AppOption configs to enable the Options menu option in the
 * primary AppBar menu.
 */
export class AppOption {
    name: string;
    prefName: string;
    fieldModel: Omit<BaseFieldConfig, 'name'>;
    formField: any;
    valueGetter: () => any;
    valueSetter: (s: any) => any;
    reloadRequired: boolean;
    refreshRequired: boolean;

    constructor({
        name,
        prefName,
        formField,
        fieldModel,
        valueGetter,
        valueSetter,
        reloadRequired = false,
        refreshRequired = true
    }: AppOptionSpec) {
        warnIf(
            !(prefName && XH.prefService.hasKey(prefName)) && !(valueGetter && valueSetter),
            'Must specify either a valid prefName or provide a valueGetter and valueSetter.'
        );

        warnIf(
            fieldModel && fieldModel.initialValue,
            `AppOption "${name}" should not set an initialValue - this will be ignored.`
        );

        this.name = name;
        this.prefName = prefName;
        this.fieldModel = fieldModel;
        this.formField = formField;
        this.valueGetter = valueGetter;
        this.valueSetter = valueSetter;
        this.reloadRequired = reloadRequired;
        this.refreshRequired = refreshRequired;
    }

    async getValueAsync() {
        const {valueGetter, prefName} = this;
        if (isFunction(valueGetter)) {
            return valueGetter();
        } else {
            return XH.prefService.get(prefName);
        }
    }

    async setValueAsync(value) {
        const {valueSetter, prefName} = this;
        if (isFunction(valueSetter)) {
            await valueSetter(value);
        } else {
            XH.prefService.set(prefName, value);
        }
    }
}