@kusto/monaco-kusto 4.1.0 → 4.1.4

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kusto/monaco-kusto",
-    "version": "4.1.0",
+    "version": "4.1.4",
     "description": "CSL, KQL plugin for the Monaco Editor",
     "author": {
         "name": "Microsoft"
@@ -55,7 +55,7 @@
     },
     "dependencies": {
         "@kusto/language-service": "2.0.0-beta.0",
-        "@kusto/language-service-next": "0.0.51"
+        "@kusto/language-service-next": "0.0.53"
     },
     "peerDependencies": {
         "monaco-editor": "^0.24.0"

package/release/dev/kustoWorker.js

@@ -6535,6 +6535,8 @@ define('vs/language/kusto/languageService/kustoLanguageService',["require", "exp
              */
             set: function (globalState) {
                 this.__kustoJsSchemaV2 = globalState;
+                this._clustersSetInGlobalState.clear();
+                this._nonEmptyDatabaseSetInGlobalState.clear();
                 // create 2 Sets with cluster names and database names based on the updated Global State. 
                 for (var i = 0; i < globalState.Clusters.Count; i++) {
                     var clusterSymbol = this._kustoJsSchemaV2.Clusters.getItem(i);
@@ -6775,14 +6777,14 @@ define('vs/language/kusto/languageService/kustoLanguageService',["require", "exp
             // Keep only unique clusters that aren't already exist in the Global State
             for (var i = 0; i < clusterReferences.Count; i++) {
                 var clusterReference = clusterReferences.getItem(i);
-                var clusterHostName = clusterReference.Cluster;
+                var clusterHostName = Kusto.Language.KustoFacts.GetHostName(clusterReference.Cluster);
                 // ignore duplicates
                 if (newClustersReferencesSet.has(clusterHostName)) {
                     continue;
                 }
                 newClustersReferencesSet.add(clusterHostName);
                 // ignore references that are already in the GlobalState.            
-                if (!this._clustersSetInGlobalState.has(clusterHostName.toLowerCase())) {
+                if (!this._clustersSetInGlobalState.has(clusterHostName)) {
                     newClustersReferences.push({ clusterName: clusterHostName });
                 }
             }
@@ -6800,8 +6802,9 @@ define('vs/language/kusto/languageService/kustoLanguageService',["require", "exp
             var newDatabasesReferencesSet = new Set();
             for (var i1 = 0; i1 < databasesReferences.Count; i1++) {
                 var databaseReference = databasesReferences.getItem(i1);
+                var clusterHostName = Kusto.Language.KustoFacts.GetHostName(databaseReference.Cluster);
                 // ignore duplicates
-                var databaseReferenceUniqueId = this.createDatabaseUniqueName(databaseReference.Cluster, databaseReference.Database);
+                var databaseReferenceUniqueId = this.createDatabaseUniqueName(clusterHostName, databaseReference.Database);
                 if (newDatabasesReferencesSet.has(databaseReferenceUniqueId)) {
                     continue;
                 }
@@ -6983,19 +6986,16 @@ define('vs/language/kusto/languageService/kustoLanguageService',["require", "exp
             return Promise.resolve();
         };
         KustoLanguageService.prototype.addDatabaseToSchema = function (document, clusterName, databaseSchema) {
-            var _this = this;
-            return new Promise(function (resolve) {
-                var clusterHostName = Kusto.Language.KustoFacts.GetHostName(clusterName);
-                var cluster = _this._kustoJsSchemaV2.GetCluster$1(clusterHostName);
-                if (!cluster) {
-                    cluster = new sym.ClusterSymbol.$ctor1(clusterHostName, null, false);
-                }
-                var databaseSymbol = KustoLanguageService.convertToDatabaseSymbol(databaseSchema);
-                cluster = cluster.AddOrUpdateDatabase(databaseSymbol);
-                _this._kustoJsSchemaV2 = _this._kustoJsSchemaV2.AddOrReplaceCluster(cluster);
-                _this._script = k2.CodeScript.From$1(document.getText(), _this._kustoJsSchemaV2);
-                resolve();
-            });
+            var clusterHostName = Kusto.Language.KustoFacts.GetHostName(clusterName);
+            var cluster = this._kustoJsSchemaV2.GetCluster$1(clusterHostName);
+            if (!cluster) {
+                cluster = new sym.ClusterSymbol.$ctor1(clusterHostName, null, false);
+            }
+            var databaseSymbol = KustoLanguageService.convertToDatabaseSymbol(databaseSchema);
+            cluster = cluster.AddOrUpdateDatabase(databaseSymbol);
+            this._kustoJsSchemaV2 = this._kustoJsSchemaV2.AddOrReplaceCluster(cluster);
+            this._script = k2.CodeScript.From$1(document.getText(), this._kustoJsSchemaV2);
+            return Promise.resolve();
         };
         KustoLanguageService.prototype.setSchema = function (schema) {
             var _this = this;
@@ -8034,7 +8034,7 @@ define('vs/language/kusto/kustoWorker',["require", "exports", "./languageService
             var document = this._getTextDocument(uri);
             if (!document) {
                 console.error("addClusterToSchema: document is " + document + ". uri is " + uri);
-                return null;
+                return Promise.resolve();
             }
             return this._languageService.addClusterToSchema(document, clusterName, databasesNames);
         };
@@ -8042,7 +8042,7 @@ define('vs/language/kusto/kustoWorker',["require", "exports", "./languageService
             var document = this._getTextDocument(uri);
             if (!document) {
                 console.error("addDatabaseToSchema: document is " + document + ". uri is " + uri);
-                return null;
+                return Promise.resolve();
             }
             return this._languageService.addDatabaseToSchema(document, clusterName, databaseSchema);
         };
@@ -8218,10 +8218,16 @@ define('vs/language/kusto/kustoWorker',["require", "exports", "./languageService
         };
         KustoWorker.prototype.getClusterReferences = function (uri, cursorOffset) {
             var document = this._getTextDocument(uri);
+            if (!document) {
+                return Promise.resolve(null);
+            }
             return this._languageService.getClusterReferences(document, cursorOffset);
         };
         KustoWorker.prototype.getDatabaseReferences = function (uri, cursorOffset) {
             var document = this._getTextDocument(uri);
+            if (!document) {
+                return Promise.resolve(null);
+            }
             return this._languageService.getDatabaseReferences(document, cursorOffset);
         };
         KustoWorker.prototype._getTextDocument = function (uri) {

package/release/esm/kustoWorker.js

@@ -15,7 +15,7 @@ var KustoWorker = /** @class */ (function () {
         var document = this._getTextDocument(uri);
         if (!document) {
             console.error("addClusterToSchema: document is " + document + ". uri is " + uri);
-            return null;
+            return Promise.resolve();
         }
         return this._languageService.addClusterToSchema(document, clusterName, databasesNames);
     };
@@ -23,7 +23,7 @@ var KustoWorker = /** @class */ (function () {
         var document = this._getTextDocument(uri);
         if (!document) {
             console.error("addDatabaseToSchema: document is " + document + ". uri is " + uri);
-            return null;
+            return Promise.resolve();
         }
         return this._languageService.addDatabaseToSchema(document, clusterName, databaseSchema);
     };
@@ -199,10 +199,16 @@ var KustoWorker = /** @class */ (function () {
     };
     KustoWorker.prototype.getClusterReferences = function (uri, cursorOffset) {
         var document = this._getTextDocument(uri);
+        if (!document) {
+            return Promise.resolve(null);
+        }
         return this._languageService.getClusterReferences(document, cursorOffset);
     };
     KustoWorker.prototype.getDatabaseReferences = function (uri, cursorOffset) {
         var document = this._getTextDocument(uri);
+        if (!document) {
+            return Promise.resolve(null);
+        }
         return this._languageService.getDatabaseReferences(document, cursorOffset);
     };
     KustoWorker.prototype._getTextDocument = function (uri) {

package/release/esm/languageService/kustoLanguageService.js

@@ -273,6 +273,8 @@ var KustoLanguageService = /** @class */ (function () {
          */
         set: function (globalState) {
             this.__kustoJsSchemaV2 = globalState;
+            this._clustersSetInGlobalState.clear();
+            this._nonEmptyDatabaseSetInGlobalState.clear();
             // create 2 Sets with cluster names and database names based on the updated Global State. 
             for (var i = 0; i < globalState.Clusters.Count; i++) {
                 var clusterSymbol = this._kustoJsSchemaV2.Clusters.getItem(i);
@@ -513,14 +515,14 @@ var KustoLanguageService = /** @class */ (function () {
         // Keep only unique clusters that aren't already exist in the Global State
         for (var i = 0; i < clusterReferences.Count; i++) {
             var clusterReference = clusterReferences.getItem(i);
-            var clusterHostName = clusterReference.Cluster;
+            var clusterHostName = Kusto.Language.KustoFacts.GetHostName(clusterReference.Cluster);
             // ignore duplicates
             if (newClustersReferencesSet.has(clusterHostName)) {
                 continue;
             }
             newClustersReferencesSet.add(clusterHostName);
             // ignore references that are already in the GlobalState.            
-            if (!this._clustersSetInGlobalState.has(clusterHostName.toLowerCase())) {
+            if (!this._clustersSetInGlobalState.has(clusterHostName)) {
                 newClustersReferences.push({ clusterName: clusterHostName });
             }
         }
@@ -538,8 +540,9 @@ var KustoLanguageService = /** @class */ (function () {
         var newDatabasesReferencesSet = new Set();
         for (var i1 = 0; i1 < databasesReferences.Count; i1++) {
             var databaseReference = databasesReferences.getItem(i1);
+            var clusterHostName = Kusto.Language.KustoFacts.GetHostName(databaseReference.Cluster);
             // ignore duplicates
-            var databaseReferenceUniqueId = this.createDatabaseUniqueName(databaseReference.Cluster, databaseReference.Database);
+            var databaseReferenceUniqueId = this.createDatabaseUniqueName(clusterHostName, databaseReference.Database);
             if (newDatabasesReferencesSet.has(databaseReferenceUniqueId)) {
                 continue;
             }
@@ -721,19 +724,16 @@ var KustoLanguageService = /** @class */ (function () {
         return Promise.resolve();
     };
     KustoLanguageService.prototype.addDatabaseToSchema = function (document, clusterName, databaseSchema) {
-        var _this = this;
-        return new Promise(function (resolve) {
-            var clusterHostName = Kusto.Language.KustoFacts.GetHostName(clusterName);
-            var cluster = _this._kustoJsSchemaV2.GetCluster$1(clusterHostName);
-            if (!cluster) {
-                cluster = new sym.ClusterSymbol.$ctor1(clusterHostName, null, false);
-            }
-            var databaseSymbol = KustoLanguageService.convertToDatabaseSymbol(databaseSchema);
-            cluster = cluster.AddOrUpdateDatabase(databaseSymbol);
-            _this._kustoJsSchemaV2 = _this._kustoJsSchemaV2.AddOrReplaceCluster(cluster);
-            _this._script = k2.CodeScript.From$1(document.getText(), _this._kustoJsSchemaV2);
-            resolve();
-        });
+        var clusterHostName = Kusto.Language.KustoFacts.GetHostName(clusterName);
+        var cluster = this._kustoJsSchemaV2.GetCluster$1(clusterHostName);
+        if (!cluster) {
+            cluster = new sym.ClusterSymbol.$ctor1(clusterHostName, null, false);
+        }
+        var databaseSymbol = KustoLanguageService.convertToDatabaseSymbol(databaseSchema);
+        cluster = cluster.AddOrUpdateDatabase(databaseSymbol);
+        this._kustoJsSchemaV2 = this._kustoJsSchemaV2.AddOrReplaceCluster(cluster);
+        this._script = k2.CodeScript.From$1(document.getText(), this._kustoJsSchemaV2);
+        return Promise.resolve();
     };
     KustoLanguageService.prototype.setSchema = function (schema) {
         var _this = this;

package/release/esm/monaco.d.ts

@@ -121,29 +121,46 @@ declare module monaco.languages.kusto {
         setParameters(parameters: ScalarParameter[]): void;
         /**
          * Get all the database references from the current command. 
-         * If database's schema is already cached it will not be returned.
+         * 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') 
-         * it returns [{ clusterName: 'help', databaseName 'Samples' }]
+         * getDatabaseReferences will return [{ clusterName: 'help', databaseName 'Samples' }]
          */
         getDatabaseReferences(uri: string, cursorOffset: number): Promise<DatabaseReference[]>;
         /**
          * Get all the cluster references from the current command.
          * If cluster's schema is already cached it will not be returned.
          * This method should be used to get all the cross-clusters in a command, then schema for the cluster should be fetched and added with addClusterToSchema.
+         * cluster name is returned exactly as written in the KQL `cluster(<cluster name>)` function.
          * @example
          * If the current command includes: cluster('help')
          * it returns [{ clusterName: 'help' }]
+         * @example
+         * If the current command includes: cluster('https://demo11.westus.kusto.windows.net')
+         * getClusterReferences will return [{ clusterName: 'https://demo11.westus.kusto.windows.net' }]
          */
         getClusterReferences(uri: string, cursorOffset: number): Promise<ClusterReference[]>;
         /**
          * Adds a database's scheme. Useful with getDatabaseReferences to load schema for cross-cluster commands.
+         * @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 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.
          */
         addDatabaseToSchema(uri: string, clusterName: string, databaseSchema: Database): Promise<void>;
         /**
-         * Adds a cluster's scheme (database names only). Useful with getClusterReferences to load schema for cross-cluster commands.
-         * To load a full database schema call addDatabaseToSchema.
+         * Adds a cluster's databases to the schema. Useful when used with getClusterReferences in cross-cluster commands.
+         * @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 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>;
     }