monaco-yql-languages 1.3.0 → 1.5.0

package/build/completion.d.ts

@@ -2,8 +2,15 @@ import type { CancellationToken, Position, editor, languages } from './fillers/m
 export type CompletionListProvider = {
     (content: string, offset: number, signal?: AbortSignal | null): Promise<string[]>;
 };
-export declare function provideCompletionItems(getCompletionList: CompletionListProvider): (model: editor.ITextModel, position: Position, context: languages.CompletionContext, token: CancellationToken) => languages.ProviderResult<languages.CompletionList>;
+type YqlCompletionType = 'Keyword' | 'PragmaName' | 'TypeName' | 'FunctionName' | 'HintName' | 'FolderName' | 'TableName' | 'ClusterName' | 'UnknownName';
+export type CompletionData = string | {
+    type: YqlCompletionType;
+    text: string;
+    shift?: number;
+};
+export declare function provideCompletionItems(getCompletionList: CompletionListProvider, preserveOrder?: boolean): (model: editor.ITextModel, position: Position, context: languages.CompletionContext, token: CancellationToken) => languages.ProviderResult<languages.CompletionList>;
 export type CompletionLists = Partial<Record<`${Uncapitalize<keyof typeof languages.CompletionItemKind>}List`, Readonly<string[]>>>;
 export declare function getCompletionItemsProvider(completions: CompletionLists, completionItemKind: typeof languages.CompletionItemKind): {
     provideCompletionItems(model: editor.ITextModel, position: Position, _context: languages.CompletionContext, _token: CancellationToken): languages.CompletionList | undefined;
 };
+export {};

package/build/completion.js

@@ -1,5 +1,17 @@
+import { suggestionIndexToWeight } from './utils';
 const allUpperCaseRe = new RegExp('^[$A-Z_\\s]+$');
-export function provideCompletionItems(getCompletionList) {
+const YqlCompletionTypeToMonacoKind = {
+    Keyword: 17,
+    PragmaName: 8,
+    TypeName: 24,
+    FunctionName: 1,
+    HintName: 18,
+    FolderName: 23,
+    TableName: 18,
+    ClusterName: 8,
+    UnknownName: 18,
+};
+export function provideCompletionItems(getCompletionList, preserveOrder) {
     return (model, position, context, token) => {
         const controller = new AbortController();
         const signal = controller.signal;
@@ -18,7 +30,23 @@ export function provideCompletionItems(getCompletionList) {
         }
         return getCompletionList(model.getValue(), model.getOffsetAt(position), signal).then(async (data) => {
             const suggestions = [];
-            for (const label of data) {
+            for (const item of data) {
+                let labelAsSnippet = '';
+                //languages.CompletionItemKind.Text
+                let kind = 18;
+                let label;
+                if (typeof item === 'object') {
+                    const { text, type, shift } = item;
+                    label = text;
+                    kind = YqlCompletionTypeToMonacoKind[type];
+                    if (shift) {
+                        const pos = text.length - shift;
+                        labelAsSnippet = text.slice(0, pos) + '$0' + text.slice(pos);
+                    }
+                }
+                else {
+                    label = item;
+                }
                 const suggest = label.length > 1
                     ? label.slice(0, -1).replace(/[/[]/g, '\\\\$&') + label.slice(-1)
                     : label;
@@ -40,8 +68,11 @@ export function provideCompletionItems(getCompletionList) {
                 suggestions.push({
                     label,
                     filterText: allUpperCaseRe.test(label) ? label.toLowerCase() : label,
-                    kind: 18, // languages.CompletionItemKind.Text,
-                    insertText: suggest,
+                    kind,
+                    insertText: labelAsSnippet || suggest,
+                    //4 - languages.CompletionItemInsertTextRule.InsertAsSnippet
+                    //0 - languages.CompletionItemInsertTextRule.None
+                    insertTextRules: labelAsSnippet ? 4 : 0,
                     command: label.endsWith('/') || label.endsWith('.`') || label.endsWith('::')
                         ? { id: 'editor.action.triggerSuggest', title: '' }
                         : undefined,
@@ -49,7 +80,12 @@ export function provideCompletionItems(getCompletionList) {
                     range,
                 });
             }
-            return { suggestions, incomplete: suggestions.length > 0 };
+            return {
+                suggestions: preserveOrder
+                    ? suggestions.map((item, index) => (Object.assign(Object.assign({}, item), { sortText: suggestionIndexToWeight(index) })))
+                    : suggestions,
+                incomplete: suggestions.length > 0,
+            };
         });
     };
 }

package/build/utils.d.ts

@@ -0,0 +1 @@
+export declare function suggestionIndexToWeight(index: number): string;

package/build/utils.js

@@ -0,0 +1,11 @@
+const alphabet = 'abcdefghijklmnopqrstuvwxyz';
+export function suggestionIndexToWeight(index) {
+    const characterInsideAlphabet = alphabet[index];
+    if (characterInsideAlphabet) {
+        return characterInsideAlphabet;
+    }
+    const duplicateTimes = Math.floor(index / alphabet.length);
+    const remains = index % alphabet.length;
+    const lastCharacter = alphabet.slice(-1);
+    return lastCharacter.repeat(duplicateTimes) + alphabet[remains];
+}

package/build/yql/autocomplete/__tests__/generateSuggestions.test.js

@@ -46,7 +46,7 @@ describe('generateColumnsSuggestion', () => {
                 kind: 1,
                 detail: 'Column',
                 range: mockRange,
-                sortText: '00',
+                sortText: 'aa',
             },
             {
                 label: { label: 'col2', description: undefined },
@@ -54,7 +54,7 @@ describe('generateColumnsSuggestion', () => {
                 kind: 1,
                 detail: 'Column',
                 range: mockRange,
-                sortText: '00',
+                sortText: 'ab',
             },
         ]);
     });
@@ -72,7 +72,7 @@ describe('generateColumnsSuggestion', () => {
                 kind: 1,
                 detail: 'Column',
                 range: mockRange,
-                sortText: '00',
+                sortText: 'aa',
             },
             {
                 label: { label: 'table2.col2', description: undefined },
@@ -80,7 +80,7 @@ describe('generateColumnsSuggestion', () => {
                 kind: 1,
                 detail: 'Column',
                 range: mockRange,
-                sortText: '00',
+                sortText: 'ab',
             },
         ]);
     });
@@ -95,7 +95,7 @@ describe('generateColumnsSuggestion', () => {
                 kind: 1,
                 detail: 'Column',
                 range: mockRange,
-                sortText: '00',
+                sortText: 'aa',
             },
         ]);
     });
@@ -111,7 +111,7 @@ describe('generateColumnsSuggestion', () => {
                 kind: 1,
                 detail: 'Column',
                 range: mockRange,
-                sortText: '00',
+                sortText: 'aa',
             },
         ]);
     });
@@ -130,7 +130,7 @@ describe('generateColumnsSuggestion', () => {
                 kind: 1,
                 detail: 'Column',
                 range: mockRange,
-                sortText: '00',
+                sortText: 'aa',
             },
             {
                 label: { label: 'table2.col2', description: undefined },
@@ -138,14 +138,14 @@ describe('generateColumnsSuggestion', () => {
                 kind: 1,
                 detail: 'Column',
                 range: mockRange,
-                sortText: '00',
+                sortText: 'ab',
             },
             {
                 label: 'table1.col1, table2.col2',
                 insertText: 'table1.col1, table2.col2',
                 kind: 1,
                 range: mockRange,
-                sortText: '0',
+                sortText: 'a',
             },
         ]);
     });
@@ -163,7 +163,7 @@ describe('generateColumnsSuggestion', () => {
                 kind: 1,
                 detail: 'Column',
                 range: mockRange,
-                sortText: '00',
+                sortText: 'aa',
             },
             {
                 label: { label: 'col1', description: undefined },
@@ -171,7 +171,7 @@ describe('generateColumnsSuggestion', () => {
                 kind: 1,
                 detail: 'Column',
                 range: mockRange,
-                sortText: '00',
+                sortText: 'ab',
             },
         ]);
     });
@@ -207,7 +207,7 @@ describe('generateEntitiesSuggestion', () => {
                     endColumn: 1,
                 },
                 command: undefined,
-                sortText: '00',
+                sortText: 'aa',
             },
             {
                 label: 'entity2/',
@@ -222,7 +222,7 @@ describe('generateEntitiesSuggestion', () => {
                     endColumn: 1,
                 },
                 command: { id: 'editor.action.triggerSuggest', title: '' },
-                sortText: '00',
+                sortText: 'ab',
             },
         ]);
     });
@@ -246,7 +246,7 @@ describe('generateEntitiesSuggestion', () => {
                     endColumn: 1,
                 },
                 command: undefined,
-                sortText: '00',
+                sortText: 'aa',
             },
             {
                 label: 'entity2/',
@@ -261,7 +261,7 @@ describe('generateEntitiesSuggestion', () => {
                     endColumn: 1,
                 },
                 command: { id: 'editor.action.triggerSuggest', title: '' },
-                sortText: '00',
+                sortText: 'ab',
             },
         ]);
     });
@@ -285,7 +285,7 @@ describe('generateEntitiesSuggestion', () => {
                     endColumn: 1,
                 },
                 command: { id: 'editor.action.triggerSuggest', title: '' },
-                sortText: '00',
+                sortText: 'aa',
             },
             {
                 label: 'entity2',
@@ -300,7 +300,7 @@ describe('generateEntitiesSuggestion', () => {
                     endColumn: 1,
                 },
                 command: undefined,
-                sortText: '00',
+                sortText: 'ab',
             },
         ]);
     });

package/build/yql/autocomplete/__tests__/utils.test.js

@@ -1,4 +1,5 @@
-import { suggestionIndexToWeight, wrapStringToBackticks } from '../utils';
+import { suggestionIndexToWeight } from '../../../utils';
+import { wrapStringToBackticks } from '../utils';
 describe('wrapStringToBackticks', () => {
     it('should return the same string if it already starts and ends with backticks', () => {
         expect(wrapStringToBackticks('`test`')).toBe('`test`');

package/build/yql/autocomplete/generateSuggestions.js

@@ -1,5 +1,6 @@
 import * as monaco from '../../fillers/monaco-editor-core';
-import { getSuggestionIndex, isVariable, removeBackticks, removeStringDuplicates, suggestionIndexToWeight, wrapStringToBackticks, } from './utils';
+import { getSuggestionIndex, isVariable, removeBackticks, removeStringDuplicates, wrapStringToBackticks, } from './utils';
+import { suggestionIndexToWeight } from '../../utils';
 export async function generateSimpleTypesSuggestion(rangeToInsertSuggestion, simpleTypes = []) {
     return simpleTypes.map((el) => ({
         label: el,

package/build/yql/autocomplete/utils.d.ts

@@ -1,7 +1,6 @@
 import type { YqlAutocompleteResult } from '@gravity-ui/websql-autocomplete/yql';
 type SuggestionType = keyof Omit<YqlAutocompleteResult, 'errors' | 'suggestDatabases'> | 'suggestAllColumns';
 export declare function getSuggestionIndex(suggestionType: SuggestionType): number;
-export declare function suggestionIndexToWeight(index: number): string;
 export declare function isVariable(value: string): boolean;
 export declare function removeStringDuplicates(value?: string[]): string[];
 export declare function getEntitiesToFetchColumns(suggestColumns: YqlAutocompleteResult['suggestColumns']): string[];

package/build/yql/autocomplete/utils.js

@@ -20,17 +20,6 @@ const SuggestionsWeight = {
 export function getSuggestionIndex(suggestionType) {
     return SuggestionsWeight[suggestionType];
 }
-const alphabet = 'abcdefghijklmnopqrstuvwxyz';
-export function suggestionIndexToWeight(index) {
-    const characterInsideAlphabet = alphabet[index];
-    if (characterInsideAlphabet) {
-        return characterInsideAlphabet;
-    }
-    const duplicateTimes = Math.floor(index / alphabet.length);
-    const remains = index % alphabet.length;
-    const lastCharacter = alphabet.slice(-1);
-    return lastCharacter.repeat(duplicateTimes) + alphabet[remains];
-}
 export function isVariable(value) {
     return value.startsWith('$');
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "monaco-yql-languages",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "YQL languages for the Monaco Editor, based on monaco-languages.",
   "author": "YDB",
   "license": "MIT",