@kusto/monaco-kusto 6.1.2 → 7.0.0

package/README.md

@@ -23,21 +23,27 @@ Kusto language plugin for the Monaco Editor. It provides the following features
 
 ### AMD module system:
 
-Example at ![https://github.com/Azure/monaco-kusto/tree/master/samples/amd]()
-
-1. Run `npm run copyMonacoFilesAMD <path>` or `yarn copyMonacoFilesAMD <path>` where <path> is where you want the monaco and kusto amd modules to be. These files will need to be served as-in.
-2. Using a amd module loader, import `vs/language/kusto/monaco.contribution`
-    1. The monaco editors included loader can be made available via a global require `require` by adding the script tag: `<script src="<path>/vs/loader.js"></script>`
-3. You should now be able to create monaco editors with `language: 'kusto'`. The kusto worker can be reached via the monaco global: `monaco.languages.kusto.getKustoWorker()`
+Example at [/samples/amd](https://github.com/Azure/monaco-kusto/tree/master/samples/amd)
+
+1. Run `npm run copyMonacoFilesAMD <path>` or `yarn copyMonacoFilesAMD <path>`
+   where <path> is where you want the monaco and kusto amd modules to be. These
+   files will need to be served as-in.
+2. Using a amd module loader, import `vs/language/kusto/monaco.contribution` 1. The monaco editors included loader can be made available via a global
+   require `require` by adding the script tag: `<script src="<path>/vs/loader.js"></script>`
+3. You should now be able to create monaco editors with `language: 'kusto'`. The
+   kusto worker can be reached via the monaco global:
+   `monaco.languages.kusto.getKustoWorker()`
+4. If using typeScript, add "@kusto/monaco-kusto/globalApi" to compilerOptions.types in tsconfig.json`
 
 ### ESM
 
-Parcel example at ![https://github.com/Azure/monaco-kusto/tree/master/samples/parcel]()
+Parcel example at [/samples/parcel](https://github.com/Azure/monaco-kusto/tree/master/samples/parcel)
 
 1. Configure your bundler so `@kusto/monaco-kusto/release/esm/kusto.worker` has it's own entry point
-2. Configure monaco with that entry point and to use `globalAPI` using the `MonacoEnvironment`. This global needs to be set _before_ the monaco editor source is parsed so it will create a global api for this package to use.
-    1. And example of steps 1 & 2 can be seen here: [./samples/parcel/index.html](). This was added to the html file to prevent parcel from including the monaco javascript above it
-3. You should now be able to create monaco editors with `language: 'kusto'`. The kusto worker can be reached via the monaco global: `monaco.languages.kusto.getKustoWorker()`
+2. Configure the global `MonacoEnvironment` with either `getWorkerUrl` or `getWorker`
+3. You should now be able to create monaco editors with `language: 'kusto'`. The
+   kusto worker can be reached via the monaco global:
+   `monaco.languages.kusto.getKustoWorker()`
 
 ### Setting a schema
 
@@ -45,9 +51,10 @@ There are 2 APIs to set a Kusto schema:
 
 1. `setSchema` - the passed schema is of type `ClusterType` (defined in `schema.ts`).
    The database in ROOT.database will be the one in context.
-2. `setSchemaFromShowSchema` - a method to set a schema from the result of the Kusto query `.show schema as json`.
-   The result is a list of databases (see interface `Result` in `schema.ts`), so when this method is used,
-   it also requires a cluster URI and the name of the database in context.
+2. `setSchemaFromShowSchema` - a method to set a schema from the result of the
+   Kusto query `.show schema as json`. The result is a list of databases (see
+   interface `Result` in `schema.ts`), so when this method is used, it also
+   requires a cluster URI and the name of the database in context.
 
 ## Contributing
 
@@ -65,6 +72,25 @@ There are 2 APIs to set a Kusto schema:
 
 ## Changelog
 
+### 7.0.0
+
+-   BREAKING CHANGE: Bumped monaco-editor peer dependency to ~0.37.0
+    -   This version of monaco-editor no longer requires a patch to work with Parcel. Details here: https://github.com/microsoft/monaco-editor/issues/2966
+-   fix: "monaco is not defined" errors when consuming esm files
+-   Moved types from global interface (`monaco.languages.kusto.*`) to esm index
+    file `import { SomeType } from '@kusto/monaco-kusto`. With this, esm
+    consumer no longer need to include
+    `@kusto/monaco-kusto/release/monaco.d.ts`.
+-   ESM output no longer requires `MonacoEnvironment.globalApi` to be `true`
+-   Moved `@kusto/monaco-kusto/release/monaco.d.ts` content to
+    `@kusto/monaco-kusto/globalApi.d.ts`. Original file now references this new
+    one, and will be removed in a future release.
+
+### 6.2.0
+
+-   Esm output not longer requires `self.MonacoEnvironment` to be true
+-   `@kusto/monaco-kusto` no exports the same api as `monaco.languages.kusto`
+
 ### 6.0.0
 
 -   Improved quality of AMD build artifacts

package/globalApi.d.ts

@@ -0,0 +1,13 @@
+// Augments monaco global types with Kusto api. Should be imported if you're using amd modules, or if you've set `MonacoEnvironment.globalApi` to true.
+
+/// <reference types="monaco-editor/monaco" />
+
+declare namespace monaco.editor {
+    export interface ICodeEditor {
+        getCurrentCommandRange(cursorPosition: monaco.Position): monaco.Range;
+    }
+}
+
+declare namespace monaco.languages {
+    export const kusto: typeof import('@kusto/monaco-kusto');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kusto/monaco-kusto",
-    "version": "6.1.2",
+    "version": "7.0.0",
     "description": "CSL, KQL plugin for the Monaco Editor",
     "author": {
         "name": "Microsoft"
@@ -28,7 +28,8 @@
     "files": [
         "release",
         "README.md",
-        "copyMonacoFilesAMD"
+        "copyMonacoFilesAMD",
+        "globalApi.d.ts"
     ],
     "bin": {
         "copyMonacoFilesAMD": "./copyMonacoFilesAMD.js"
@@ -53,13 +54,13 @@
         "concurrently": "^7.6.0",
         "http-server": "^0.12.3",
         "live-server": "^1.2.1",
-        "monaco-editor": "~0.35.0",
+        "monaco-editor": "~0.37.0",
         "monaco-languages": "2.11.1",
         "rimraf": "^4.1.2",
         "rollup": "^3.17.3",
         "terser": "^5.16.2",
         "ts-node": "^10.9.1",
-        "typescript": "^4.0.0",
+        "typescript": "^5.0.4",
         "vscode-languageserver-textdocument": "1.0.4"
     },
     "dependencies": {
@@ -70,6 +71,6 @@
         "xregexp": "^5.1.1"
     },
     "peerDependencies": {
-        "monaco-editor": "~0.35.0"
+        "monaco-editor": "~0.37.0"
     }
 }

package/release/dev/kustoMode.js

@@ -1,11 +1,30 @@
 /*!-----------------------------------------------------------------------------
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * monaco-kusto version: 6.1.2(4c9ec21ad04b49f9f8e8a8f7fe773fe9a8b47334)
+ * monaco-kusto version: 7.0.0(f23f8fe8dd705f8413d0d094c76eb0af2131aace)
  * Released under the MIT license
  * https://https://github.com/Azure/monaco-kusto/blob/master/README.md
  *-----------------------------------------------------------------------------*/
 
-define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function (exports, main) { 'use strict';
+define('vs/language/kusto/kustoMode', ['exports', 'vs/editor/editor.main', './main-5ef10bd7'], (function (exports, monaco, main) { 'use strict';
+
+    function _interopNamespaceDefault(e) {
+        var n = Object.create(null);
+        if (e) {
+            Object.keys(e).forEach(function (k) {
+                if (k !== 'default') {
+                    var d = Object.getOwnPropertyDescriptor(e, k);
+                    Object.defineProperty(n, k, d.get ? d : {
+                        enumerable: true,
+                        get: function () { return e[k]; }
+                    });
+                }
+            });
+        }
+        n.default = e;
+        return Object.freeze(n);
+    }
+
+    var monaco__namespace = /*#__PURE__*/_interopNamespaceDefault(monaco);
 
     var _excluded = ["onDidProvideCompletionItems"];
     function _typeof$7(obj) { "@babel/helpers - typeof"; return _typeof$7 = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof$7(obj); }
@@ -697,12 +716,9 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
     function _defineProperty$1(obj, key, value) { key = _toPropertyKey$1(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
     function _toPropertyKey$1(arg) { var key = _toPrimitive$1(arg, "string"); return _typeof$1(key) === "symbol" ? key : String(key); }
     function _toPrimitive$1(input, hint) { if (_typeof$1(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof$1(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-    var Uri = monaco.Uri;
-    monaco.Position;
-    var Range = monaco.Range;
-    monaco.Thenable;
-    monaco.CancellationToken;
-    monaco.IDisposable; // --- diagnostics ---
+
+    // --- diagnostics ---
+
     var DiagnosticsAdapter = /*#__PURE__*/function () {
       function DiagnosticsAdapter(_monacoInstance, _languageId, _worker, defaults, onSchemaChange) {
         var _this = this;
@@ -787,7 +803,7 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
           }
         };
         if (this.defaults.languageSettings.enableQuickFixes) {
-          this._disposables.push(monaco.languages.registerCodeActionProvider(this._languageId, {
+          this._disposables.push(monaco__namespace.languages.registerCodeActionProvider(this._languageId, {
             provideCodeActions: function () {
               var _provideCodeActions = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(model, range, context, _token) {
                 var startOffset, endOffset, showQuickFix, actions;
@@ -1029,16 +1045,16 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
                       overviewRuler: {
                         // The color indication on the right ruler
                         color: 'rgb(255, 18, 18, 0.7)',
-                        position: monaco.editor.OverviewRulerLane.Right
+                        position: monaco__namespace.editor.OverviewRulerLane.Right
                       },
                       minimap: {
                         color: 'rgb(255, 18, 18, 0.7)',
-                        position: monaco.editor.MinimapPosition.Inline
+                        position: monaco__namespace.editor.MinimapPosition.Inline
                       }
                     }
                   };
                 });
-                var oldMarkers = monaco.editor.getModelMarkers({
+                var oldMarkers = monaco__namespace.editor.getModelMarkers({
                   owner: languageId,
                   resource: resource
                 });
@@ -1071,15 +1087,15 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
     function toSeverity(lsSeverity) {
       switch (lsSeverity) {
         case main.DiagnosticSeverity.Error:
-          return monaco.MarkerSeverity.Error;
+          return monaco__namespace.MarkerSeverity.Error;
         case main.DiagnosticSeverity.Warning:
-          return monaco.MarkerSeverity.Warning;
+          return monaco__namespace.MarkerSeverity.Warning;
         case main.DiagnosticSeverity.Information:
-          return monaco.MarkerSeverity.Info;
+          return monaco__namespace.MarkerSeverity.Info;
         case main.DiagnosticSeverity.Hint:
-          return monaco.MarkerSeverity.Hint;
+          return monaco__namespace.MarkerSeverity.Hint;
         default:
-          return monaco.MarkerSeverity.Info;
+          return monaco__namespace.MarkerSeverity.Info;
       }
     }
     function toDiagnostics(resource, diag) {
@@ -1288,7 +1304,7 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
 
         /**
          * Return true if the range doesn't intersect any of the line ranges.
-         * @param range Range
+         * @param range monaco.Range
          * @param impactedLineRanges an array of line ranges
          */
       }, {
@@ -1411,13 +1427,13 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
     function toDecoration(model, classification) {
       var start = model.getPositionAt(classification.start);
       var end = model.getPositionAt(classification.start + classification.length);
-      var range = new Range(start.lineNumber, start.column, end.lineNumber, end.column);
+      var range = new monaco__namespace.Range(start.lineNumber, start.column, end.lineNumber, end.column);
       var inlineClassName = ClassificationKindNames[classification.kind];
       return {
         range: range,
         options: {
           inlineClassName: inlineClassName,
-          stickiness: monaco.editor.TrackedRangeStickiness.NeverGrowsWhenTypingAtEdges
+          stickiness: monaco__namespace.editor.TrackedRangeStickiness.NeverGrowsWhenTypingAtEdges
         }
       };
     }
@@ -1445,10 +1461,10 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
       if (!range) {
         return void 0;
       }
-      return new Range(range.start.line + 1, range.start.character + 1, range.end.line + 1, range.end.character + 1);
+      return new monaco__namespace.Range(range.start.line + 1, range.start.character + 1, range.end.line + 1, range.end.character + 1);
     }
     function toCompletionItemKind(kind) {
-      var mItemKind = monaco.languages.CompletionItemKind;
+      var mItemKind = monaco__namespace.languages.CompletionItemKind;
       switch (kind) {
         case main.CompletionItemKind.Text:
           return mItemKind.Text;
@@ -1511,7 +1527,7 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
           var linkWithoutPostfix = prop.toString().replace('.md', '');
           // Sometimes we get the link as a full URL. For example in the main doc link of the item
           var fullURL = linkWithoutPostfix.startsWith('https') ? linkWithoutPostfix : "".concat(DOCS_BASE_URL, "/").concat(linkWithoutPostfix);
-          return monaco.Uri.parse(fullURL);
+          return monaco__namespace.Uri.parse(fullURL);
         }
       });
       return {
@@ -1535,7 +1551,7 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
         key: "provideCompletionItems",
         value: function provideCompletionItems(model, position, context, token) {
           var wordInfo = model.getWordUntilPosition(position);
-          var wordRange = new Range(position.lineNumber, wordInfo.startColumn, position.lineNumber, wordInfo.endColumn);
+          var wordRange = new monaco__namespace.Range(position.lineNumber, wordInfo.startColumn, position.lineNumber, wordInfo.endColumn);
           var resource = model.uri;
           var onDidProvideCompletionItems = this.languageSettings.onDidProvideCompletionItems;
           return this._worker(resource).then(function (worker) {
@@ -1553,17 +1569,19 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
                 insertText: entry.insertText,
                 sortText: entry.sortText,
                 filterText: entry.filterText,
+                // TODO: Is this cast safe?
                 documentation: formatDocLink((_entry$documentation = entry.documentation) === null || _entry$documentation === void 0 ? void 0 : _entry$documentation.value),
                 detail: entry.detail,
                 range: wordRange,
                 kind: toCompletionItemKind(entry.kind)
               };
               if (entry.textEdit) {
+                // TODO: Where is the "range" property coming from?
                 item.range = toRange(entry.textEdit.range);
                 item.insertText = entry.textEdit.newText;
               }
               if (entry.insertTextFormat === main.InsertTextFormat.Snippet) {
-                item.insertTextRules = monaco.languages.CompletionItemInsertTextRule.InsertAsSnippet;
+                item.insertTextRules = monaco__namespace.languages.CompletionItemInsertTextRule.InsertAsSnippet;
               }
               return item;
             });
@@ -1613,7 +1631,7 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
 
     function toLocation(location) {
       return {
-        uri: Uri.parse(location.uri),
+        uri: monaco__namespace.Uri.parse(location.uri),
         range: toRange(location.range)
       };
     }
@@ -1671,7 +1689,7 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
       }
       var resourceEdits = [];
       for (var _uri2 in edit.changes) {
-        var _uri = Uri.parse(_uri2);
+        var _uri = monaco__namespace.Uri.parse(_uri2);
         var _iterator = _createForOfIteratorHelper(edit.changes[_uri2]),
           _step;
         try {
@@ -1783,7 +1801,7 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
       return {
         start: range.startLine + 1,
         end: range.endLine + 1,
-        kind: monaco.languages.FoldingRangeKind.Region
+        kind: monaco__namespace.languages.FoldingRangeKind.Region
       };
     }
 
@@ -1826,8 +1844,6 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
     function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
     function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
     function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
-    monaco.Uri;
-    monaco.IDisposable;
     var kustoWorker;
     var resolveWorker;
     var workerPromise = new Promise(function (resolve, reject) {
@@ -1839,7 +1855,7 @@ define('vs/language/kusto/kustoMode', ['exports', './main-1f7cc4fa'], (function
      * @param defaults
      */
     function setupMode(defaults, monacoInstance) {
-      var onSchemaChange = new monaco.Emitter();
+      var onSchemaChange = new monaco__namespace.Emitter();
       // TODO: when should we dispose of these? seems like monaco-css and monaco-typescript don't dispose of these.
       var disposables = [];
       var monarchTokensProvider;

package/release/dev/kustoWorker.js

@@ -1,11 +1,11 @@
 /*!-----------------------------------------------------------------------------
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * monaco-kusto version: 6.1.2(4c9ec21ad04b49f9f8e8a8f7fe773fe9a8b47334)
+ * monaco-kusto version: 7.0.0(f23f8fe8dd705f8413d0d094c76eb0af2131aace)
  * Released under the MIT license
  * https://https://github.com/Azure/monaco-kusto/blob/master/README.md
  *-----------------------------------------------------------------------------*/
 
-define('vs/language/kusto/kustoWorker', ['exports', './main-1f7cc4fa'], (function (exports, main) { 'use strict';
+define('vs/language/kusto/kustoWorker', ['exports', './main-5ef10bd7'], (function (exports, main) { 'use strict';
 
     function _slicedToArray$2(arr, i) { return _arrayWithHoles$2(arr) || _iterableToArrayLimit$2(arr, i) || _unsupportedIterableToArray$3(arr, i) || _nonIterableRest$2(); }
     function _nonIterableRest$2() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }

package/release/dev/{main-1f7cc4fa.js → main-5ef10bd7.js}

@@ -1,11 +1,11 @@
 /*!-----------------------------------------------------------------------------
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * monaco-kusto version: 6.1.2(4c9ec21ad04b49f9f8e8a8f7fe773fe9a8b47334)
+ * monaco-kusto version: 7.0.0(f23f8fe8dd705f8413d0d094c76eb0af2131aace)
  * Released under the MIT license
  * https://https://github.com/Azure/monaco-kusto/blob/master/README.md
  *-----------------------------------------------------------------------------*/
 
-define('vs/language/kusto/main-1f7cc4fa', ['exports'], (function (exports) { 'use strict';
+define('vs/language/kusto/main-5ef10bd7', ['exports'], (function (exports) { 'use strict';
 
     /* --------------------------------------------------------------------------------------------
      * Copyright (c) Microsoft Corporation. All rights reserved.