@kusto/monaco-kusto 5.3.10 → 5.3.12

package/release/min/monaco.d.ts

@@ -25,7 +25,7 @@ declare module monaco.languages.kusto {
         formatter?: FormatterOptions;
         enableQueryWarnings?: boolean;
         enableQuerySuggestions?: boolean;
-        disabledDiagnoticCodes?: string[];
+        disabledDiagnosticCodes?: string[];
     }
 
     export interface SyntaxErrorAsMarkDownOptions {
@@ -38,7 +38,7 @@ declare module monaco.languages.kusto {
         indentationSize?: number;
         pipeOperatorStyle?: FormatterPlacementStyle;
     }
-    
+
     export type FormatterPlacementStyle = 'None' | 'NewLine' | 'Smart';
 
     export interface LanguageServiceDefaults {
@@ -99,7 +99,7 @@ declare module monaco.languages.kusto {
 
         /**
          * Get all the ambient parameters defined in global scope.
-         * Ambient parameters are parameters that are not defined in the syntax such as in a query paramter declaration.
+         * Ambient parameters are parameters that are not defined in the syntax such as in a query parameter declaration.
          * These are parameters that are injected from outside, usually by a UX application that would like to offer
          * the user intellisense for a symbol, without forcing them to write a query declaration statement.
          * Usually  the same application injects the query declaration statement and the parameter values when
@@ -121,14 +121,22 @@ declare module monaco.languages.kusto {
         doDocumentFormat(uri: string): Promise<ls.TextEdit[]>;
         doRangeFormat(uri: string, range: ls.Range): Promise<ls.TextEdit[]>;
         doCurrentCommandFormat(uri: string, caretPosition: ls.Position): Promise<ls.TextEdit[]>;
-        doValidation(uri: string, intervals: { start: number; end: number }[], includeWarnings?: boolean, includeSuggestions?: boolean): Promise<ls.Diagnostic[]>;
-        setParameters(scalarParameters: ScalarParameter[], tabularParameters: TabularParameter): void;
+        doValidation(
+            uri: string,
+            intervals: { start: number; end: number }[],
+            includeWarnings?: boolean,
+            includeSuggestions?: boolean
+        ): Promise<ls.Diagnostic[]>;
+        setParameters(
+            scalarParameters: readonly ScalarParameter[],
+            tabularParameters: readonly TabularParameter[]
+        ): void;
         /**
-         * Get all the database references from the current command. 
+         * Get all the database references from the current command.
          * If database's schema is already cached in previous calls to setSchema or addDatabaseToSchema it will not be returned.
          * This method should be used to get all the cross-databases in a command, then schema for the database should be fetched and added with addDatabaseToSchema.
          * @example
-         * If the current command includes: cluster('help').database('Samples') 
+         * If the current command includes: cluster('help').database('Samples')
          * getDatabaseReferences will return [{ clusterName: 'help', databaseName 'Samples' }]
          */
         getDatabaseReferences(uri: string, cursorOffset: number): Promise<DatabaseReference[]>;
@@ -150,7 +158,7 @@ declare module monaco.languages.kusto {
          * @param clusterName the name of the cluster as returned from getDatabaseReferences/getClusterReferences.
          * @example
          * - User enters cluster('help').database('Samples')
-         * - hosting app calls getDatabaseReferences which returns [{ clusterName: 'help', databaseName: 'Samples' }]. 
+         * - hosting app calls getDatabaseReferences which returns [{ clusterName: 'help', databaseName: 'Samples' }].
          * - hosting app fetches the database Schema from https://help.kusto.windows.net
          * - hosting app calls 'addDatabaseToSchema' with the database's schema.
          * - now, when user types cluster('help').database('Samples') then the auto complete list will show all the tables.
@@ -161,12 +169,12 @@ declare module monaco.languages.kusto {
          * @param clusterName the name of the cluster as returned in getClusterReferences.
          * @example
          * - User enters cluster('help')
-         * - hosting app calls getClusterReferences which returns [{ clusterName: 'help' }]. 
+         * - hosting app calls getClusterReferences which returns [{ clusterName: 'help' }].
          * - hosting app fetches the list of databases from https://help.kusto.windows.net
          * - hosting app calls addClusterToSchema with the list of databases.
          * - now, when user type `cluster('help').database(` then the auto complete list will show all the databases.
          */
-        addClusterToSchema(uri: string, clusterName: string, databasesNames: string[]): Promise<void>;
+        addClusterToSchema(uri: string, clusterName: string, databasesNames: readonly string[]): Promise<void>;
     }
 
     /**
@@ -194,8 +202,10 @@ declare module monaco.languages.kusto {
         cslDefaultValue?: string;
     }
 
-    export interface TabularParameter extends ScalarParameter {
-        columns: Column[]
+    export interface TabularParameter {
+        name: string;
+        columns: Column[];
+        docstring?: string;
     }
 
     // an input parameter either be a scalar in which case it has a name, type and cslType, or it can be columnar, in which case
@@ -288,11 +298,11 @@ declare module monaco.languages.kusto {
 
     export interface DatabaseReference {
         databaseName: string;
-        clusterName: string; 
-    };
+        clusterName: string;
+    }
 
     export interface ClusterReference {
-        clusterName: string; 
+        clusterName: string;
     }
 
     export type RenderOptionKeys = keyof RenderOptions;

package/scripts/bundle.js

@@ -1,7 +1,7 @@
 const requirejs = require('requirejs');
 const path = require('path');
 const fs = require('fs');
-const Terser = require("terser");
+const Terser = require('terser');
 const helpers = require('monaco-plugin-helpers');
 
 const REPO_ROOT = path.resolve(__dirname, '..');
@@ -11,55 +11,62 @@ const semver = require('../package.json').version;
 const headerVersion = semver + '(' + sha1 + ')';
 
 const BUNDLED_FILE_HEADER = [
-	'/*!-----------------------------------------------------------------------------',
-	' * Copyright (c) Microsoft Corporation. All rights reserved.',
-	' * monaco-kusto version: ' + headerVersion,
-	' * Released under the MIT license',
-	' * https://https://github.com/Azure/monaco-kusto/blob/master/README.md',
-	' *-----------------------------------------------------------------------------*/',
-	''
+    '/*!-----------------------------------------------------------------------------',
+    ' * Copyright (c) Microsoft Corporation. All rights reserved.',
+    ' * monaco-kusto version: ' + headerVersion,
+    ' * Released under the MIT license',
+    ' * https://https://github.com/Azure/monaco-kusto/blob/master/README.md',
+    ' *-----------------------------------------------------------------------------*/',
+    '',
 ].join('\n');
 
-bundleOne('monaco.contribution', ['vs/language/kusto/kustoMode']),
-bundleOne('kustoMode'),
-bundleOne('kustoWorker')
+bundleOne('monaco.contribution', ['vs/language/kusto/kustoMode']), bundleOne('kustoMode'), bundleOne('kustoWorker');
 
 function bundleOne(moduleId, exclude) {
-	requirejs.optimize({
-		baseUrl: './',
-		name: 'vs/language/kusto/' + moduleId,
-		out: 'release/dev/' + moduleId + '.js',
-		exclude: exclude,
-		paths: {
-			'vs/language/kusto': REPO_ROOT + '/out/amd'
-		},
-		optimize: 'none',
-		packages: [{
-			name: 'vscode-languageserver-types',
-			location: path.join(REPO_ROOT, '/node_modules/vscode-languageserver-types/lib/umd'),
-			main: 'main'
-		}, {
-			name: 'xregexp',
-			location: path.join(REPO_ROOT, '/node_modules/xregexp'),
-			main: 'xregexp-all.js'
-		}, {
-			name: 'lodash',
-			location: path.join(REPO_ROOT, '/node_modules/lodash'),
-			main: 'lodash.min.js'
-		}],
-	}, function (buildResponse) {
-		const devFilePath = path.join(REPO_ROOT, 'release/dev/' + moduleId + '.js');
-		const minFilePath = path.join(REPO_ROOT, 'release/min/' + moduleId + '.js');
-		const fileContents = fs.readFileSync(devFilePath).toString();
-		console.log();
-		console.log(`Minifying ${devFilePath}...`);
-		const result = Terser.minify(fileContents, {
-			output: {
-				comments: 'some'
-			}
-		});
-		console.log(`Done.`);
-		try { fs.mkdirSync(path.join(REPO_ROOT, 'release/min')) } catch (err) { }
-		fs.writeFileSync(minFilePath, BUNDLED_FILE_HEADER + result.code);
-	})
+    requirejs.optimize(
+        {
+            baseUrl: './',
+            name: 'vs/language/kusto/' + moduleId,
+            out: 'release/dev/' + moduleId + '.js',
+            exclude: exclude,
+            paths: {
+                'vs/language/kusto': REPO_ROOT + '/out/amd',
+            },
+            optimize: 'none',
+            packages: [
+                {
+                    name: 'vscode-languageserver-types',
+                    location: path.join(REPO_ROOT, '/node_modules/vscode-languageserver-types/lib/umd'),
+                    main: 'main',
+                },
+                {
+                    name: 'xregexp',
+                    location: path.join(REPO_ROOT, '/node_modules/xregexp'),
+                    main: 'xregexp-all.js',
+                },
+                {
+                    name: 'lodash',
+                    location: path.join(REPO_ROOT, '/node_modules/lodash'),
+                    main: 'lodash.min.js',
+                },
+            ],
+        },
+        function (buildResponse) {
+            const devFilePath = path.join(REPO_ROOT, 'release/dev/' + moduleId + '.js');
+            const minFilePath = path.join(REPO_ROOT, 'release/min/' + moduleId + '.js');
+            const fileContents = fs.readFileSync(devFilePath).toString();
+            console.log();
+            console.log(`Minifying ${devFilePath}...`);
+            const result = Terser.minify(fileContents, {
+                output: {
+                    comments: 'some',
+                },
+            });
+            console.log(`Done.`);
+            try {
+                fs.mkdirSync(path.join(REPO_ROOT, 'release/min'));
+            } catch (err) {}
+            fs.writeFileSync(minFilePath, BUNDLED_FILE_HEADER + result.code);
+        }
+    );
 }

package/scripts/release.js

@@ -4,23 +4,16 @@ const helpers = require('monaco-plugin-helpers');
 const REPO_ROOT = path.join(__dirname, '../');
 
 helpers.packageESM({
-	repoRoot: REPO_ROOT,
-	esmSource: 'out/esm',
-	esmDestination: 'release/esm',
-	entryPoints: [
-		'monaco.contribution.js',
-		'kustoMode.js',
-		'kusto.worker.js',
-	],
-	resolveAlias: {
-	},
-	resolveSkip: [
-		'monaco-editor-core'
-	],
-	destinationFolderSimplification: {
-		'node_modules': '_deps',
-		'vscode-languageserver-types/lib/esm': 'vscode-languageserver-types',
-		'/node_modules/xregexp': 'xregexp',
-		'/node_modules/lodash': 'lodash'
-	}
-});
+    repoRoot: REPO_ROOT,
+    esmSource: 'out/esm',
+    esmDestination: 'release/esm',
+    entryPoints: ['monaco.contribution.js', 'kustoMode.js', 'kusto.worker.js'],
+    resolveAlias: {},
+    resolveSkip: ['monaco-editor-core'],
+    destinationFolderSimplification: {
+        node_modules: '_deps',
+        'vscode-languageserver-types/lib/esm': 'vscode-languageserver-types',
+        '/node_modules/xregexp': 'xregexp',
+        '/node_modules/lodash': 'lodash',
+    },
+});

package/tsconfig.esm.json

@@ -0,0 +1,18 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "compilerOptions": {
+        "module": "esnext",
+        "moduleResolution": "node",
+        "outDir": "./out/esm",
+        "target": "es5",
+        "lib": ["es2020", "dom", "WebWorker.ImportScripts"],
+        "alwaysStrict": true,
+        "declaration": true,
+        "skipLibCheck": true,
+        "types": [
+            "monaco-editor-core/monaco",
+            "@kusto/language-service/Kusto.JavaScript.Client",
+            "@kusto/language-service-next/Kusto.Language.Bridge"
+        ]
+    }
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "include": ["./src/**/*"],
+    "compilerOptions": {
+        "rootDir": "./src",
+        "module": "amd",
+        "moduleResolution": "node",
+        "outDir": "./out/amd",
+        "target": "es5",
+        "lib": ["es2020", "dom", "WebWorker.ImportScripts"],
+        "alwaysStrict": true,
+        "declaration": true,
+        "skipLibCheck": true,
+        "types": [
+            "monaco-editor-core/monaco",
+            "@kusto/language-service/Kusto.JavaScript.Client",
+            "@kusto/language-service-next/Kusto.Language.Bridge"
+        ]
+    }
+}

package/tsconfig.watch.json

@@ -0,0 +1,8 @@
+{
+    "$schema": "https://json.schemastore.org/tsconfig",
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "sourceMap": true,
+        "sourceRoot": "./src"
+    }
+}