summaryrefslogtreecommitdiffstats
path: root/webapp/stores/suggestion_store.jsx
diff options
context:
space:
mode:
Diffstat (limited to 'webapp/stores/suggestion_store.jsx')
-rw-r--r--webapp/stores/suggestion_store.jsx329
1 files changed, 0 insertions, 329 deletions
diff --git a/webapp/stores/suggestion_store.jsx b/webapp/stores/suggestion_store.jsx
deleted file mode 100644
index 902886ed7..000000000
--- a/webapp/stores/suggestion_store.jsx
+++ /dev/null
@@ -1,329 +0,0 @@
-// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
-// See License.txt for license information.
-
-import AppDispatcher from 'dispatcher/app_dispatcher.jsx';
-import Constants from 'utils/constants.jsx';
-import EventEmitter from 'events';
-
-const ActionTypes = Constants.ActionTypes;
-
-const COMPLETE_WORD_EVENT = 'complete_word';
-const PRETEXT_CHANGED_EVENT = 'pretext_changed';
-const SUGGESTIONS_CHANGED_EVENT = 'suggestions_changed';
-const POPOVER_MENTION_KEY_CLICK_EVENT = 'popover_mention_key_click';
-
-class SuggestionStore extends EventEmitter {
- constructor() {
- super();
-
- this.addSuggestionsChangedListener = this.addSuggestionsChangedListener.bind(this);
- this.removeSuggestionsChangedListener = this.removeSuggestionsChangedListener.bind(this);
- this.emitSuggestionsChanged = this.emitSuggestionsChanged.bind(this);
-
- this.addPretextChangedListener = this.addPretextChangedListener.bind(this);
- this.removePretextChangedListener = this.removePretextChangedListener.bind(this);
- this.emitPretextChanged = this.emitPretextChanged.bind(this);
-
- this.addCompleteWordListener = this.addCompleteWordListener.bind(this);
- this.removeCompleteWordListener = this.removeCompleteWordListener.bind(this);
- this.emitCompleteWord = this.emitCompleteWord.bind(this);
-
- this.addPopoverMentionKeyClickListener = this.addPopoverMentionKeyClickListener.bind(this);
- this.removePopoverMentionKeyClickListener = this.removePopoverMentionKeyClickListener.bind(this);
- this.emitPopoverMentionKeyClick = this.emitPopoverMentionKeyClick.bind(this);
-
- this.handleEventPayload = this.handleEventPayload.bind(this);
- this.dispatchToken = AppDispatcher.register(this.handleEventPayload);
-
- // this.suggestions stores the state of all SuggestionBoxes by mapping their unique identifier to an
- // object with the following fields:
- // pretext: the text before the cursor
- // matchedPretext: a list of the text before the cursor that will be replaced if the corresponding autocomplete term is selected
- // terms: a list of strings which the previously typed text may be replaced by
- // items: a list of objects backing the terms which may be used in rendering
- // components: a list of react components that can be used to render their corresponding item
- // selection: the term currently selected by the keyboard
- this.suggestions = new Map();
- }
-
- addSuggestionsChangedListener(id, callback) {
- this.on(SUGGESTIONS_CHANGED_EVENT + id, callback);
- }
- removeSuggestionsChangedListener(id, callback) {
- this.removeListener(SUGGESTIONS_CHANGED_EVENT + id, callback);
- }
- emitSuggestionsChanged(id) {
- this.emit(SUGGESTIONS_CHANGED_EVENT + id);
- }
-
- addPretextChangedListener(id, callback) {
- this.on(PRETEXT_CHANGED_EVENT + id, callback);
- }
- removePretextChangedListener(id, callback) {
- this.removeListener(PRETEXT_CHANGED_EVENT + id, callback);
- }
- emitPretextChanged(id, pretext) {
- this.emit(PRETEXT_CHANGED_EVENT + id, pretext);
- }
-
- addCompleteWordListener(id, callback) {
- this.on(COMPLETE_WORD_EVENT + id, callback);
- }
- removeCompleteWordListener(id, callback) {
- this.removeListener(COMPLETE_WORD_EVENT + id, callback);
- }
- emitCompleteWord(id, term, matchedPretext) {
- this.emit(COMPLETE_WORD_EVENT + id, term, matchedPretext);
- }
-
- addPopoverMentionKeyClickListener(id, callback) {
- this.on(POPOVER_MENTION_KEY_CLICK_EVENT + id, callback);
- }
- removePopoverMentionKeyClickListener(id, callback) {
- this.removeListener(POPOVER_MENTION_KEY_CLICK_EVENT + id, callback);
- }
- emitPopoverMentionKeyClick(isRHS, mentionKey) {
- this.emit(POPOVER_MENTION_KEY_CLICK_EVENT + isRHS, mentionKey);
- }
-
- registerSuggestionBox(id) {
- this.suggestions.set(id, {
- pretext: '',
- matchedPretext: [],
- terms: [],
- items: [],
- components: [],
- selection: ''
- });
- }
-
- unregisterSuggestionBox(id) {
- this.suggestions.delete(id);
- }
-
- clearSuggestions(id) {
- const suggestion = this.getSuggestions(id);
-
- suggestion.matchedPretext = [];
- suggestion.terms = [];
- suggestion.items = [];
- suggestion.components = [];
- }
-
- clearSelection(id) {
- const suggestion = this.getSuggestions(id);
-
- suggestion.selection = '';
- }
-
- hasSuggestions(id) {
- return this.getSuggestions(id).terms.length > 0;
- }
-
- setPretext(id, pretext) {
- const suggestion = this.getSuggestions(id);
-
- suggestion.pretext = pretext;
- }
-
- addSuggestion(id, term, item, component, matchedPretext) {
- const suggestion = this.getSuggestions(id);
-
- suggestion.terms.push(term);
- suggestion.items.push(item);
- suggestion.components.push(component);
- suggestion.matchedPretext.push(matchedPretext);
- }
-
- addSuggestions(id, terms, items, component, matchedPretext) {
- const suggestion = this.getSuggestions(id);
-
- suggestion.terms.push(...terms);
- suggestion.items.push(...items);
-
- for (let i = 0; i < terms.length; i++) {
- suggestion.components.push(component);
- suggestion.matchedPretext.push(matchedPretext);
- }
- }
-
- // make sure that if suggestions exist, then one of them is selected. return true if the selection changes.
- ensureSelectionExists(id) {
- const suggestion = this.getSuggestions(id);
-
- if (suggestion.terms.length > 0) {
- // if the current selection is no longer in the map, select the first term in the list
- if (!suggestion.selection || suggestion.terms.indexOf(suggestion.selection) === -1) {
- suggestion.selection = suggestion.terms[0];
-
- return true;
- }
- } else if (suggestion.selection) {
- suggestion.selection = '';
-
- return true;
- }
-
- return false;
- }
-
- getPretext(id) {
- return this.getSuggestions(id).pretext;
- }
-
- getSelectedMatchedPretext(id) {
- const suggestion = this.getSuggestions(id);
-
- for (let i = 0; i < suggestion.terms.length; i++) {
- if (suggestion.terms[i] === suggestion.selection) {
- return suggestion.matchedPretext[i];
- }
- }
-
- return '';
- }
-
- getItems(id) {
- return this.getSuggestions(id).items;
- }
-
- getTerms(id) {
- return this.getSuggestions(id).terms;
- }
-
- getComponents(id) {
- return this.getSuggestions(id).components;
- }
-
- getSuggestions(id) {
- return this.suggestions.get(id) || {};
- }
-
- getSelection(id) {
- return this.getSuggestions(id).selection;
- }
-
- selectNext(id) {
- this.setSelectionByDelta(id, 1);
- }
-
- selectPrevious(id) {
- this.setSelectionByDelta(id, -1);
- }
-
- setSelectionByDelta(id, delta) {
- const suggestion = this.suggestions.get(id);
-
- let selectionIndex = suggestion.terms.indexOf(suggestion.selection);
-
- if (selectionIndex === -1) {
- // this should never happen since selection should always be in terms
- throw new Error('selection is not in terms');
- }
-
- selectionIndex += delta;
-
- if (selectionIndex < 0) {
- selectionIndex = 0;
- } else if (selectionIndex > suggestion.terms.length - 1) {
- selectionIndex = suggestion.terms.length - 1;
- }
-
- suggestion.selection = suggestion.terms[selectionIndex];
- }
-
- checkIfPretextMatches(id, matchedPretext) {
- const pretext = this.getPretext(id) || '';
- return pretext.endsWith(matchedPretext);
- }
-
- setSuggestionsPending(id, pending) {
- this.suggestions.get(id).suggestionsPending = pending;
- }
-
- areSuggestionsPending(id) {
- return this.suggestions.get(id).suggestionsPending;
- }
-
- setCompletePending(id, pending) {
- this.suggestions.get(id).completePending = pending;
- }
-
- isCompletePending(id) {
- return this.suggestions.get(id).completePending;
- }
-
- completeWord(id, term = '', matchedPretext = '') {
- this.emitCompleteWord(id, term || this.getSelection(id), matchedPretext || this.getSelectedMatchedPretext(id));
-
- this.setPretext(id, '');
- this.clearSuggestions(id);
- this.clearSelection(id);
- this.emitSuggestionsChanged(id);
- }
-
- handleEventPayload(payload) {
- const {type, id, ...other} = payload.action;
-
- switch (type) {
- case ActionTypes.SUGGESTION_PRETEXT_CHANGED:
- // Clear the suggestions if the pretext is empty or ends with whitespace
- if (other.pretext === '') {
- this.clearSuggestions(id);
- }
-
- other.pretext = other.pretext.toLowerCase();
-
- this.setPretext(id, other.pretext);
- this.emitPretextChanged(id, other.pretext);
-
- this.ensureSelectionExists(id);
- this.emitSuggestionsChanged(id);
- break;
- case ActionTypes.SUGGESTION_RECEIVED_SUGGESTIONS:
- if (!this.checkIfPretextMatches(id, other.matchedPretext)) {
- // These suggestions are out of date since the pretext has changed
- return;
- }
-
- this.clearSuggestions(id);
- this.addSuggestions(id, other.terms, other.items, other.component, other.matchedPretext);
- this.ensureSelectionExists(id);
-
- this.setSuggestionsPending(id, false);
-
- if (this.isCompletePending(id)) {
- this.completeWord(id);
- } else {
- this.emitSuggestionsChanged(id);
- }
- break;
- case ActionTypes.SUGGESTION_CLEAR_SUGGESTIONS:
- this.setPretext(id, '');
- this.clearSuggestions(id);
- this.clearSelection(id);
- this.emitSuggestionsChanged(id);
- break;
- case ActionTypes.SUGGESTION_SELECT_NEXT:
- this.selectNext(id);
- this.emitSuggestionsChanged(id);
- break;
- case ActionTypes.SUGGESTION_SELECT_PREVIOUS:
- this.selectPrevious(id);
- this.emitSuggestionsChanged(id);
- break;
- case ActionTypes.SUGGESTION_COMPLETE_WORD:
- if (this.areSuggestionsPending(id)) {
- this.setCompletePending(id, true);
- } else {
- this.completeWord(id, other.term, other.matchedPretext);
- }
- break;
- case ActionTypes.POPOVER_MENTION_KEY_CLICK:
- this.emitPopoverMentionKeyClick(other.isRHS, other.mentionKey);
- break;
- }
- }
-}
-
-export default new SuggestionStore();
generated by cgit v1.2.3-1-g7c22 (git 2.25.1) at 2024-05-20 08:01:54 +0000