Ghost/ghost/admin/app/components/gh-token-input.js

/* global key */
import * as shortcuts from '../utils/shortcuts';
import Component from '@glimmer/component';
import Ember from 'ember';
import {A, isArray} from '@ember/array';
import {action, get} from '@ember/object';
import {
    advanceSelectableOption,
    defaultMatcher,
    filterOptions
} from 'ember-power-select/utils/group-utils';
import {htmlSafe} from '@ember/template';
import {isBlank} from '@ember/utils';
import {task} from 'ember-concurrency';

const {Handlebars} = Ember;

const BACKSPACE = 8;
const TAB = 9;

export default class GhTokenInput extends Component {
    get matcher() {
        return this.args.matcher || defaultMatcher;
    }

    get searchField() {
        return this.args.searchField === undefined ? 'name' : this.args.searchField;
    }

    get optionsWithoutSelected() {
        let options = this.args.options;
        let selected = this.args.selected;

        let optionsWithoutSelected = [];

        function filterSelectedOptions(opts, result) {
            opts.forEach((o) => {
                if (o.options) {
                    const withoutSelected = [];
                    filterSelectedOptions(o.options, withoutSelected);

                    if (withoutSelected.length > 0) {
                        result.push({
                            groupName: o.groupName,
                            options: withoutSelected
                        });
                    }

                    return;
                }

                if (!selected.includes(o)) {
                    result.push(o);
                }
            });
        }

        filterSelectedOptions(options, optionsWithoutSelected);

        return optionsWithoutSelected;
    }

    // actions -----------------------------------------------------------------

    @action
    handleKeydown(select, event) {
        // On backspace with empty text, remove the last token but deviate
        // from default behaviour by not updating search to match last token
        if (event.keyCode === BACKSPACE && isBlank(event.target.value)) {
            let lastSelection = select.selected[select.selected.length - 1];

            if (lastSelection) {
                this.args.onChange(select.selected.slice(0, -1), select);
                select.actions.search('');
                select.actions.open(event);
            }

            // prevent default
            return false;
        }

        // Tab should work the same as Enter if there's a highlighted option
        if (event.keyCode === TAB && !isBlank(event.target.value) && select.highlighted) {
            if (!select.selected || select.selected.indexOf(select.highlighted) === -1) {
                select.actions.choose(select.highlighted, event);
                event.preventDefault(); // keep focus in search
                return false;
            }
        }

        // https://github.com/TryGhost/Ghost/issues/11786
        // ember-power-select stops propagation of events when ctrl/CMD or meta key is down.
        // So, we're dispatching KeyboardEvent directly to the root of ghost app.
        if (event.ctrlKey || event.metaKey) {
            // Only dispatch KeyboardEvent to the root when it's a registered shortcut.
            if (shortcuts.includes(event)) {
                const copy = new KeyboardEvent(event.type, event);
                document.getElementsByClassName('gh-app')[0].dispatchEvent(copy);
                event.preventDefault(); // don't show the save dialog.

                return false;
            }
        }

        // fallback to default
        return true;
    }

    @action
    handleFocus() {
        key.setScope('gh-token-input');
        this.args.onFocus?.(...arguments);
    }

    @action
    handleBlur() {
        key.setScope('default');
        this.args.onBlur?.(...arguments);
    }

    @action
    searchAndSuggest(term, select) {
        return this.searchAndSuggestTask.perform(term, select);
    }

    @action
    selectOrCreate(selection, select, keyboardEvent) {
        // allow tokens to be created with spaces
        if (keyboardEvent && keyboardEvent.code === 'Space') {
            select.actions.search(`${select.searchText} `);
            return;
        }

        // guard against return being pressed when nothing is selected
        if (!isArray(selection)) {
            return;
        }

        let suggestion = selection.find(option => option.__isSuggestion__);

        if (suggestion) {
            this.args.onCreate(suggestion.__value__, select);
        } else {
            this.args.onChange(selection, select);
        }

        // clear select search
        select.actions.search('');
    }

    // tasks -------------------------------------------------------------------

    @task
    *searchAndSuggestTask(term, select) {
        let newOptions = this.optionsWithoutSelected.toArray();

        if (term.length === 0) {
            return newOptions;
        }

        let searchAction = this.args.search;
        if (searchAction) {
            let results = yield searchAction(term, select);

            if (results.toArray) {
                results = results.toArray();
            }

            this._addCreateOption(term, results);
            return results;
        }

        newOptions = this._filter(A(newOptions), term);
        this._addCreateOption(term, newOptions);

        return newOptions;
    }

    // internal ----------------------------------------------------------------

    // always select the first item in the list that isn't the "Add x" option
    @action
    defaultHighlighted(select) {
        let {results} = select;
        let option = advanceSelectableOption(results, undefined, 1);

        if (results.length > 1 && option.__isSuggestion__) {
            option = advanceSelectableOption(results, option, 1);
        }

        return option;
    }

    // private -----------------------------------------------------------------

    _addCreateOption(term, options) {
        if (this._shouldShowCreateOption(term, options)) {
            options.unshift(this._buildSuggestionForTerm(term));
        }
    }

    _shouldShowCreateOption(term, options) {
        if (this.args.allowCreation === false) {
            return false;
        }

        if (this.args.showCreateWhen) {
            return this.args.showCreateWhen(term, options);
        } else {
            return this._hideCreateOptionOnSameTerm(term, options);
        }
    }

    _buildSuggestionForTerm(term) {
        return {
            __isSuggestion__: true,
            __value__: term,
            text: this._buildSuggestionLabel(term)
        };
    }

    _hideCreateOptionOnSameTerm(term, options) {
        let existingOption = options.findBy(this.searchField, term);
        return !existingOption;
    }

    _filter(options, searchText) {
        let matcher;
        if (this.searchField) {
            matcher = (option, text) => this.matcher(get(option, this.searchField), text);
        } else {
            matcher = (option, text) => this.matcher(option, text);
        }
        return filterOptions(options || [], searchText, matcher);
    }

    _buildSuggestionLabel(term) {
        if (this.args.buildSuggestion) {
            return this.args.buildSuggestion(term);
        }
        return htmlSafe(`Add <strong>"${Handlebars.Utils.escapeExpression(term)}"...</strong>`);
    }
}