@eccenca/gui-elements 22.0.1 → 22.1.0

package/src/components/AutoSuggestion/AutoSuggestion.scss

@@ -0,0 +1,100 @@
+//@import "~@eccenca/gui-elements/src/configuration.default";
+
+.ecc-auto-suggestion-box {
+    position: relative;
+
+    &__dropdown {
+        transition: all 300ms;
+        // TODO: Replace by variable
+        background-color: #fff;
+        position: absolute;
+        top: $eccgui-size-textfield-height-regular;
+        z-index:2;
+        display: flex;
+        flex-flow: column wrap;
+        margin-top: 0;
+        max-width: 25rem;
+        max-height: 30rem;
+        // TODO: was: 1px solid $list-container-item-border-color
+        border: 1px solid;
+        border-radius: 0.3rem;
+        overflow-x:hidden;
+        overflow-y: auto;
+
+        .#{$ns}-menu, .#{$eccgui}-overviewitem__item {
+            max-width: 24rem;
+            box-sizing: border-box;
+        }
+    }
+}
+
+.ecc-input-editor {
+    position: relative;
+
+    .CodeMirror {
+        height: calc(#{$eccgui-size-textfield-height-regular} - 4px);
+        margin: 0;
+        padding: 0;
+        top: 2px;
+        overflow: hidden;
+    }
+
+    .CodeMirror-scroll {
+        margin: 0;
+        padding: 0;
+        overflow-y: hidden !important;
+        overflow-x: auto !important;
+    }
+
+    .CodeMirror-vscrollbar {
+        display: none !important;
+    }
+
+    .CodeMirror-sizer {
+        border: none;
+    }
+
+    .CodeMirror-lines {
+        padding: 0;
+        line-height: calc(#{$eccgui-size-textfield-height-regular} - 4px - 6px);
+    }
+
+    pre.CodeMirror-line {
+        font-family: $eccgui-font-family-monospace;
+        font-size: 0.9em;
+        padding: 3px 0;
+        height: calc(#{$eccgui-size-textfield-height-regular} - 4px - 6px);
+        box-sizing: content-box;
+    }
+
+    .CodeMirror-cursor {
+        border: none;
+        margin: 0;
+        width: 1px;
+        background-color: transparent;
+
+        &::after {
+            content: " ";
+            height: 1rem;
+            width: 1px;
+            overflow: hidden;
+            background-color: black;
+            position: absolute;
+            top: 50%;
+            right: 0;
+            margin-top: -0.5rem;
+        }
+    }
+}
+
+.ecc-text-highlighting {
+    display: inline-block;
+    background-color: $eccgui-color-warning-background;
+    color:$eccgui-color-warning-text;
+}
+
+.ecc-text-error-highlighting {
+    background-image:url("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAADCAYAAAC09K7GAAAAAXNSR0IArs4c6QAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB9sJDw4cOCW1/KIAAAAZdEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIEdJTVBXgQ4XAAAAHElEQVQI12NggIL/DAz/GdA5/xkY/qPKMDAwAADLZwf5rvm+LQAAAABJRU5ErkJggg==");
+    background-position: left bottom;
+    background-repeat: repeat-x;
+}

package/src/components/AutoSuggestion/AutoSuggestion.tsx

@@ -0,0 +1,448 @@
+import React, {useCallback, useEffect, useState} from "react";
+import CodeMirror from "codemirror";
+import {FieldItem, IconButton, Spinner, Toolbar, ToolbarSection} from "./../../";
+import {Classes as BlueprintClassNames} from "@blueprintjs/core";
+
+//custom components
+import SingleLineCodeEditor, {IRange} from "./SingleLineCodeEditor";
+import {AutoSuggestionList} from "./AutoSuggestionList";
+import {debounce} from "lodash";
+
+export enum OVERWRITTEN_KEYS {
+    ArrowUp = "ArrowUp",
+    ArrowDown = "ArrowDown",
+    Enter = "Enter",
+    Tab = "Tab",
+}
+export type OverwrittenKeyTypes = typeof OVERWRITTEN_KEYS[keyof typeof OVERWRITTEN_KEYS];
+
+/** A single suggestion. */
+export interface ISuggestionBase {
+    // The actual value
+    value: string
+    // Optional human-readable label
+    label?: string
+    // Optional description of the value.
+    description?: string
+}
+
+/** Same as ISuggestionBase, but with the query that was used to fetch this suggestion. */
+export interface ISuggestionWithReplacementInfo extends ISuggestionBase {
+    // The query this result was filtered by
+    query: string
+    // The offset of the original string that should be replaced
+    from: number
+    // The length of the original string that should be replaced
+    length: number
+}
+
+/** The suggestions for a specific substring of the given input string. */
+export interface IReplacementResult {
+    // The range of the input string that should be replaced
+    replacementInterval: {
+        from: number
+        length: number
+    }
+    // The extracted query from the local value at the cursor position of the path that was used to retrieve the suggestions.
+    extractedQuery: string
+    // The suggested replacements for the substring that should be replaced.
+    replacements: ISuggestionBase[]
+}
+
+export interface IPartialAutoCompleteResult {
+    // Repeats the input string from the corresponding request
+    inputString: string
+    // Repeats the cursor position from the corresponding request
+    cursorPosition: number
+    replacementResults: IReplacementResult[]
+}
+
+/** Validation result */
+export interface IValidationResult {
+    // If the input value is valid or not
+    valid: boolean,
+    parseError?: {
+        // Detail error message
+        message: string
+        // Start of the parse error in the input string
+        start: number
+        // End of the parse error in the input string
+        end: number
+    }
+}
+
+export interface IProps {
+    // Optional label to be shown for the input (above). This will create a FieldItem around the input.
+    label?: string
+    // The value the component is initialized with, do not use this to control value changes.
+    initialValue: string
+    // Callback on value change
+    onChange: (currentValue: string) => any
+    // Fetches the suggestions
+    fetchSuggestions: (inputString: string, cursorPosition: number) => (IPartialAutoCompleteResult | undefined) | Promise<IPartialAutoCompleteResult | undefined>
+    // Checks if the input is valid
+    checkInput?: (inputString: string) => IValidationResult | Promise<IValidationResult | undefined>
+    // Called with the input validation result
+    onInputChecked?: (validInput: boolean) => any
+    // Text that should be shown if the input validation failed.
+    validationErrorText?: string
+    // Text that should be shown when hovering over the clear icon
+    clearIconText?: string
+    // Called when focus status changes
+    onFocusChange?: (hasFocus: boolean) => any
+    // Optional ID to attach to the outer element
+    id?: string
+    // If the <Tab> key should be used for auto-completing items. Else it will have its default behavior.
+    useTabForCompletions?: boolean
+    /** An additional element that is put to the left side of the input field */
+    leftElement?: JSX.Element | null
+    // An additional element that is put to the right side of the input field
+    rightElement?: JSX.Element | null
+    /** Placeholder tobe shown when no text has been entered, yet. */
+    placeholder?: string
+    /** If the horizontal scrollbars should be shown. */
+    showScrollBar?: boolean
+}
+
+/** Input component that allows partial, fine-grained auto-completion, i.e. of sub-strings of the input string.
+ * This is comparable to a one line code editor. */
+const AutoSuggestion = ({
+                            label,
+                            initialValue,
+                            onChange,
+                            fetchSuggestions,
+                            checkInput,
+                            validationErrorText = "Invalid value",
+                            clearIconText = "Clear",
+                            onFocusChange,
+                            id,
+                            onInputChecked,
+                            leftElement,
+                            rightElement,
+                            useTabForCompletions = false,
+                            placeholder,
+                            showScrollBar = true
+                        }: IProps) => {
+    const [value, setValue] = React.useState(initialValue);
+    const [cursorPosition, setCursorPosition] = React.useState(0);
+    const [coords, setCoords] = React.useState({left: 0});
+    const [shouldShowDropdown, setShouldShowDropdown] = React.useState(false);
+    const [suggestions, setSuggestions] = React.useState<ISuggestionWithReplacementInfo[]>([]);
+    const [suggestionsPending, setSuggestionsPending] = React.useState(false);
+    const [pathValidationPending, setPathValidationPending] = React.useState(false)
+    const [, setErrorMarkers] = React.useState<CodeMirror.TextMarker[]>([]);
+    const [validationResponse, setValidationResponse] = useState<IValidationResult | undefined>(undefined)
+    const [suggestionResponse, setSuggestionResponse] = useState<IPartialAutoCompleteResult | undefined>(undefined)
+    // The element that should be used for replacement highlighting
+    const [highlightedElement, setHighlightedElement] = useState<ISuggestionWithReplacementInfo | undefined>(undefined)
+    const [editorInstance, setEditorInstance] = React.useState<CodeMirror.Editor>();
+    const [isFocused, setIsFocused] = React.useState(false);
+    /** Mutable editor state, since this needs to be current in scope of the SingleLineEditorComponent. */
+    const [editorState] = React.useState<{
+        index: number,
+        suggestions: ISuggestionWithReplacementInfo[],
+        editorInstance?: CodeMirror.Editor,
+        dropdownShown: boolean
+    }>({index: 0, suggestions: [], dropdownShown: false})
+    /** This is for the AutoSuggestionList component in order to re-render. */
+    const [focusedIndex, setFocusedIndex] = React.useState(0)
+    const [selectedTextRanges, setSelectedTextRanges] = useState<IRange[]>([])
+
+    const pathIsValid = validationResponse?.valid ?? true;
+
+    const setCurrentIndex = (newIndex: number) => {
+        editorState.index = newIndex
+        setFocusedIndex(newIndex)
+    }
+    const currentIndex = () => editorState.index
+
+    React.useEffect(() => {
+        editorState.editorInstance = editorInstance
+    }, [editorInstance, editorState])
+
+    React.useEffect(() => {
+        setValue(initialValue)
+    }, [initialValue])
+
+    React.useEffect(() => {
+        editorState.dropdownShown = shouldShowDropdown
+    }, [shouldShowDropdown, editorState])
+
+    // Handle replacement highlighting
+    useEffect(() => {
+        if (highlightedElement && editorInstance) {
+            const { from, length } = highlightedElement;
+            if(length > 0 && selectedTextRanges.length === 0) {
+                const to = from + length;
+                const marker = editorInstance.markText(
+                    {line: 0, ch: from},
+                    {line: 0, ch: to},
+                    {className: "ecc-text-highlighting"}
+                );
+                return () => marker.clear()
+            }
+        }
+        return;
+    }, [highlightedElement, selectedTextRanges, editorInstance])
+
+    //handle linting
+    React.useEffect(() => {
+        const parseError = validationResponse?.parseError;
+        if (parseError && editorInstance) {
+            const { message, start, end } = parseError;
+            editorInstance.getDoc().getEditor()
+            const marker = editorInstance.markText(
+                { line: 0, ch: start },
+                { line: 0, ch: end },
+                { className: "ecc-text-error-highlighting", title: message }
+            );
+            setErrorMarkers((previousMarkers) => {
+                previousMarkers.forEach(marker => marker.clear())
+                return [marker]
+            });
+        } else {
+            // Valid, clear all error markers
+            setErrorMarkers((previous) => {
+                previous.forEach(marker => marker.clear())
+                return []
+            })
+        }
+        onInputChecked && onInputChecked(!!validationResponse?.valid)
+    }, [validationResponse?.valid, validationResponse?.parseError, editorInstance, onInputChecked]);
+
+    /** generate suggestions and also populate the replacement indexes dict */
+    React.useEffect(() => {
+        let newSuggestions: ISuggestionWithReplacementInfo[] = [];
+        if (
+            suggestionResponse?.replacementResults?.length === 1 &&
+            !suggestionResponse?.replacementResults[0]?.replacements?.length
+        ) {
+            setShouldShowDropdown(false);
+        }
+        if (suggestionResponse?.replacementResults?.length) {
+            suggestionResponse.replacementResults.forEach(
+                ({ replacements, replacementInterval: { from, length }, extractedQuery }) => {
+                    const replacementsWithMetaData = replacements.map(r => ({...r, query: extractedQuery, from, length}))
+                    newSuggestions = [...newSuggestions, ...replacementsWithMetaData];
+                }
+            );
+            editorState.suggestions = newSuggestions
+            setSuggestions(newSuggestions);
+        } else {
+            editorState.suggestions = []
+            setSuggestions([])
+        }
+        editorState.index = 0
+    }, [suggestionResponse, editorState]);
+
+    const asyncCheckInput = async (inputString: string) => {
+        if(!checkInput) {
+            return
+        }
+        setPathValidationPending(true)
+        try {
+            const result: IValidationResult | undefined = await checkInput(inputString)
+            setValidationResponse(result)
+        } catch(e) {
+            setValidationResponse(undefined)
+            // TODO: Error handling
+        } finally {
+            setPathValidationPending(false)
+        }
+    }
+
+    const checkValuePathValidity = useCallback(
+        debounce((inputString: string) => asyncCheckInput(inputString), 200),
+        [checkInput]
+    )
+
+    const handleEditorInputChange = useCallback(
+        debounce((inputString: string, cursorPosition: number) => asyncHandleEditorInputChange(inputString, cursorPosition), 200),
+        [fetchSuggestions]
+    )
+
+    React.useEffect(() => {
+        if (isFocused) {
+            setShouldShowDropdown(true);
+            handleEditorInputChange(value, cursorPosition)
+            return handleEditorInputChange.cancel
+        }
+        return;
+    }, [cursorPosition, value, isFocused, handleEditorInputChange]);
+
+    // Trigger input validation
+    useEffect(() => {
+        checkValuePathValidity(value)
+        return checkValuePathValidity.cancel
+    }, [value, checkValuePathValidity])
+
+    const asyncHandleEditorInputChange = async (inputString: string, cursorPosition: number) => {
+        setSuggestionsPending(true)
+        try {
+            const result: IPartialAutoCompleteResult | undefined = await fetchSuggestions(inputString, cursorPosition)
+            setSuggestionResponse(result)
+        } catch(e) {
+            setSuggestionResponse(undefined)
+            // TODO: Error handling
+        } finally {
+            setSuggestionsPending(false)
+        }
+    }
+
+    const handleChange = (val: string) => {
+        setValue(val);
+        onChange(val)
+    };
+
+    const handleCursorChange = (pos: any, coords: any) => {
+        setCursorPosition(pos.ch);
+        setCoords(() => coords);
+    };
+
+    const handleInputEditorKeyPress = (event: KeyboardEvent) => {
+        const overWrittenKeys: Array<string> = Object.values(OVERWRITTEN_KEYS);
+        if (overWrittenKeys.includes(event.key) && (useTabForCompletions || event.key !== OVERWRITTEN_KEYS.Tab)) {
+            event.preventDefault();
+            makeDropDownRespondToKeyPress(OVERWRITTEN_KEYS[event.key as keyof typeof OVERWRITTEN_KEYS]);
+        }
+    };
+
+    const closeDropDown = () => {
+        setHighlightedElement(undefined)
+        setShouldShowDropdown(false)
+    }
+
+    const handleDropdownChange = (selectedSuggestion: ISuggestionWithReplacementInfo) => {
+        if (selectedSuggestion && editorState.editorInstance) {
+            const { from, length, value } = selectedSuggestion;
+            const to = from + length;
+            editorState.editorInstance.replaceRange(selectedSuggestion.value, {line: 0, ch: from}, {line: 0, ch: to})
+            closeDropDown()
+            editorState.editorInstance.setCursor({ line: 0, ch: from + value.length });
+            editorState.editorInstance.focus();
+        }
+    };
+
+    const handleInputEditorClear = () => {
+        handleChange("");
+        setValue("")
+        editorInstance?.focus();
+    };
+
+    const handleInputFocus = (focusState: boolean) => {
+        onFocusChange && onFocusChange(focusState)
+        setIsFocused(focusState)
+        focusState ? setShouldShowDropdown(true) : closeDropDown()
+    };
+
+    //keyboard handlers
+    const handleArrowDown = () => {
+        const lastSuggestionIndex = editorState.suggestions.length - 1;
+        setCurrentIndex(currentIndex() === lastSuggestionIndex ? 0 : currentIndex() + 1)
+    };
+
+    const handleArrowUp = () => {
+        const lastSuggestionIndex = editorState.suggestions.length - 1;
+        setCurrentIndex(currentIndex() === 0 ? lastSuggestionIndex : currentIndex() - 1)
+    };
+
+    const handleEnterPressed = () => {
+        handleDropdownChange(editorState.suggestions[currentIndex()]);
+        setCurrentIndex(0);
+    };
+
+    const handleTabPressed = () => {
+        handleDropdownChange(editorState.suggestions[currentIndex()]);
+    };
+
+    const makeDropDownRespondToKeyPress = (keyPressedFromInput: OverwrittenKeyTypes) => {
+        // React state unknown
+        if (editorState.dropdownShown) {
+            switch (keyPressedFromInput) {
+                case OVERWRITTEN_KEYS.ArrowUp:
+                    handleArrowUp();
+                    break;
+                case OVERWRITTEN_KEYS.ArrowDown:
+                    handleArrowDown();
+                    break;
+                case OVERWRITTEN_KEYS.Enter:
+                    handleEnterPressed();
+                    break;
+                case OVERWRITTEN_KEYS.Tab:
+                    handleTabPressed();
+                    break;
+                default:
+                    //do nothing
+            }
+        }
+    };
+
+    const handleItemHighlighting = React.useCallback((item: ISuggestionWithReplacementInfo | undefined) => {
+        setHighlightedElement(item)
+    }, [])
+
+    const hasError = !!value && !pathIsValid && !pathValidationPending;
+    const autoSuggestionInput = <div id={id} className="ecc-auto-suggestion-box">
+        <div className={`ecc-auto-suggestion-box__editor-box ${BlueprintClassNames.INPUT_GROUP} ${BlueprintClassNames.FILL} ${hasError ? BlueprintClassNames.INTENT_DANGER : ""}`}>
+            <SingleLineCodeEditor
+                mode="null"
+                setEditorInstance={setEditorInstance}
+                onChange={handleChange}
+                onCursorChange={handleCursorChange}
+                initialValue={value}
+                onFocusChange={handleInputFocus}
+                onKeyDown={handleInputEditorKeyPress}
+                enableTab={useTabForCompletions}
+                placeholder={placeholder}
+                onSelection={setSelectedTextRanges}
+                showScrollBar={showScrollBar}
+            />
+            {!!value && (
+                <span className={BlueprintClassNames.INPUT_ACTION}>
+                            <IconButton
+                                data-test-id={"value-path-clear-btn"}
+                                name="operation-clear"
+                                text={clearIconText}
+                                onClick={handleInputEditorClear}
+                            />
+                        </span>
+            )}
+        </div>
+        {shouldShowDropdown ? <AutoSuggestionList
+            left={coords.left}
+            loading={suggestionsPending}
+            options={suggestions}
+            isOpen={!suggestionsPending && shouldShowDropdown}
+            onItemSelectionChange={handleDropdownChange}
+            currentlyFocusedIndex={focusedIndex}
+            itemToHighlight={handleItemHighlighting}
+        /> : null}
+    </div>
+
+    const withRightElement = rightElement || leftElement ? <Toolbar noWrap={true}>
+        {leftElement && <ToolbarSection>{leftElement}</ToolbarSection>}
+        <ToolbarSection canGrow={true}>{autoSuggestionInput}</ToolbarSection>
+        {rightElement && <ToolbarSection>{rightElement}</ToolbarSection>}
+    </Toolbar> : autoSuggestionInput
+
+    return label ? (
+        <FieldItem
+            labelAttributes={{
+                text: (
+                    <>
+                        {label}
+                        &nbsp;
+                        {(pathValidationPending || suggestionsPending) && (
+                            <Spinner size="tiny" position="inline" description="Validating value path" />
+                        )}
+                    </>)
+            }}
+            hasStateDanger={hasError}
+            messageText={hasError ? validationErrorText : undefined}
+        >
+            {withRightElement}
+        </FieldItem>
+    ) : withRightElement
+};
+
+export default AutoSuggestion;