azure-kusto-data 2.2.3 → 3.2.0

package/.eslintignore

@@ -0,0 +1,5 @@
+node_modules
+**/*.d.ts
+**/*.js
+coverage
+.nyc_output

package/.eslintrc.js

@@ -0,0 +1,247 @@
+/*
+👋 Hi! This file was autogenerated by tslint-to-eslint-config.
+https://github.com/typescript-eslint/tslint-to-eslint-config
+
+It represents the closest reasonable ESLint configuration to this
+project's original TSLint configuration.
+
+We recommend eventually switching this configuration to extend from
+the recommended rulesets in typescript-eslint.
+https://github.com/typescript-eslint/tslint-to-eslint-config/blob/master/docs/FAQs.md
+
+Happy linting! 💖
+*/
+module.exports = {
+    "env": {
+        "browser": true,
+        "es6": true,
+        "node": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking",
+        "prettier"
+    ],
+    "ignorePatterns": [
+        "node_modules",
+        "**/*.d.ts",
+        "**/*.js"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": "tsconfig.json",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "eslint-plugin-jsdoc",
+        "eslint-plugin-prefer-arrow",
+        "@typescript-eslint",
+        "header"
+    ],
+    "rules": {
+        "@typescript-eslint/adjacent-overload-signatures": "error",
+        "@typescript-eslint/array-type": [
+            "error",
+            {
+                "default": "array"
+            }
+        ],
+        "@typescript-eslint/ban-ts-comment": "error",
+        "@typescript-eslint/ban-types": [
+            "error",
+            {
+                "types": {
+                    "Object": {
+                        "message": "Avoid using the `Object` type. Did you mean `object`?"
+                    },
+                    "Function": {
+                        "message": "Avoid using the `Function` type. Prefer a specific function type, like `() => void`."
+                    },
+                    "Boolean": {
+                        "message": "Avoid using the `Boolean` type. Did you mean `boolean`?"
+                    },
+                    "Number": {
+                        "message": "Avoid using the `Number` type. Did you mean `number`?"
+                    },
+                    "String": {
+                        "message": "Avoid using the `String` type. Did you mean `string`?"
+                    },
+                    "Symbol": {
+                        "message": "Avoid using the `Symbol` type. Did you mean `symbol`?"
+                    }
+                }
+            }
+        ],
+        "@typescript-eslint/consistent-type-assertions": "error",
+        "@typescript-eslint/dot-notation": "error",
+        "@typescript-eslint/no-array-constructor": "error",
+        "@typescript-eslint/no-empty-interface": "error",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-extra-non-null-assertion": "error",
+        "@typescript-eslint/no-extra-semi": "error",
+        "@typescript-eslint/no-loss-of-precision": "error",
+        "@typescript-eslint/no-misused-new": "error",
+        "@typescript-eslint/no-namespace": "error",
+        "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
+        "@typescript-eslint/no-parameter-properties": "off",
+        "@typescript-eslint/no-shadow": [
+            "error",
+            {
+                "hoist": "all"
+            }
+        ],
+        "@typescript-eslint/no-this-alias": "error",
+        "@typescript-eslint/no-unnecessary-type-constraint": "error",
+        "@typescript-eslint/no-unused-expressions": "error",
+        "@typescript-eslint/no-unused-vars": "warn",
+        "@typescript-eslint/no-use-before-define": "off",
+        "@typescript-eslint/no-var-requires": "error",
+        "@typescript-eslint/prefer-as-const": "error",
+        "@typescript-eslint/prefer-for-of": "error",
+        "@typescript-eslint/prefer-function-type": "error",
+        "@typescript-eslint/prefer-namespace-keyword": "error",
+        "@typescript-eslint/triple-slash-reference": [
+            "error",
+            {
+                "path": "always",
+                "types": "prefer-import",
+                "lib": "always"
+            }
+        ],
+        "@typescript-eslint/unified-signatures": "error",
+        "complexity": "off",
+        "constructor-super": "error",
+        "dot-notation": "error",
+        "eqeqeq": [
+            "error",
+            "smart"
+        ],
+        "for-direction": "error",
+        "getter-return": "error",
+        "guard-for-in": "error",
+        "id-denylist": [
+            "error",
+            "any",
+            "Number",
+            "number",
+            "String",
+            "string",
+            "Boolean",
+            "boolean",
+            "Undefined",
+            "undefined"
+        ],
+        "id-match": "error",
+        "jsdoc/check-alignment": "error",
+        "jsdoc/check-indentation": "error",
+        "jsdoc/newline-after-description": "error",
+        "max-classes-per-file": [
+            "error",
+            1
+        ],
+        "new-parens": "error",
+        "no-array-constructor": "off",
+        "no-async-promise-executor": "error",
+        "no-bitwise": "error",
+        "no-caller": "error",
+        "no-case-declarations": "error",
+        "no-class-assign": "error",
+        "no-compare-neg-zero": "error",
+        "no-cond-assign": "error",
+        "no-console": "error",
+        "no-const-assign": "error",
+        "no-control-regex": "error",
+        "no-debugger": "error",
+        "no-delete-var": "error",
+        "no-dupe-args": "error",
+        "no-dupe-class-members": "error",
+        "no-dupe-else-if": "error",
+        "no-dupe-keys": "error",
+        "no-duplicate-case": "error",
+        "no-empty": "error",
+        "no-empty-character-class": "error",
+        "no-empty-pattern": "error",
+        "no-eval": "error",
+        "no-ex-assign": "error",
+        "no-extra-boolean-cast": "error",
+        "no-extra-semi": "off",
+        "no-fallthrough": "off",
+        "no-func-assign": "error",
+        "no-global-assign": "error",
+        "no-import-assign": "error",
+        "no-inner-declarations": "error",
+        "no-invalid-regexp": "error",
+        "no-invalid-this": "off",
+        "no-irregular-whitespace": "error",
+        "no-loss-of-precision": "off",
+        "no-misleading-character-class": "error",
+        "no-mixed-spaces-and-tabs": "error",
+        "no-new-symbol": "error",
+        "no-new-wrappers": "error",
+        "no-nonoctal-decimal-escape": "error",
+        "no-obj-calls": "error",
+        "no-octal": "error",
+        "no-prototype-builtins": "error",
+        "no-redeclare": "error",
+        "no-regex-spaces": "error",
+        "no-self-assign": "error",
+        "no-setter-return": "error",
+        "no-shadow-restricted-names": "error",
+        "no-sparse-arrays": "error",
+        "no-this-before-super": "error",
+        "no-throw-literal": "error",
+        "no-trailing-spaces": "error",
+        "no-undef-init": "error",
+        "no-unexpected-multiline": "error",
+        "no-unreachable": "error",
+        "no-unsafe-finally": "error",
+        "no-unsafe-negation": "error",
+        "no-unsafe-optional-chaining": "error",
+        "no-unused-expressions": "error",
+        "no-unused-labels": "error",
+        "no-unused-vars": "off",
+        "no-use-before-define": "off",
+        "no-useless-backreference": "error",
+        "no-useless-catch": "error",
+        "no-useless-escape": "error",
+        "no-var": "error",
+        "no-with": "error",
+        "object-shorthand": "error",
+        "one-var": [
+            "error",
+            "never"
+        ],
+        "prefer-arrow/prefer-arrow-functions": "error",
+        "prefer-const": "error",
+        "radix": "error",
+        "require-yield": "error",
+        "spaced-comment": [
+            "error",
+            "always",
+            {
+                "markers": [
+                    "/"
+                ]
+            }
+        ],
+        "use-isnan": "error",
+        "valid-typeof": "off",
+
+        // Rules that were added manually
+
+        "header/header": ["error", "line", " Copyright (c) Microsoft Corporation.\n Licensed under the MIT License."],
+
+        // Disabled rules to avoid too many changes, consider re-enabling in the future
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-unsafe-argument": "off",
+        "@typescript-eslint/no-unsafe-return": "off",
+        "@typescript-eslint/restrict-template-expressions": "off",
+        "@typescript-eslint/no-empty-function": "off",
+        "@typescript-eslint/no-inferrable-types": "off",
+        "no-undef":"off",
+        "@typescript-eslint/no-non-null-assertion":"off",
+        "@typescript-eslint/no-unnecessary-type-assertion":"off",
+        "no-constant-condition": "off",
+    }
+};

package/.prettierignore

@@ -0,0 +1,7 @@
+node_modules
+**/*.d.ts
+**/*.js
+!example.js
+coverage
+.nyc_output
+test/data/response/*

package/.prettierrc.json

@@ -0,0 +1,5 @@
+{
+    "endOfLine": "auto",
+    "printWidth": 160,
+    "tabWidth": 4
+}

package/README.md

@@ -6,56 +6,66 @@
 
 ## Quick Start
 
-```javascript 
+```javascript
 const KustoClient = require("azure-kusto-data").Client;
 const KustoConnectionStringBuilder = require("azure-kusto-data").KustoConnectionStringBuilder;
 
-const kcsb = KustoConnectionStringBuilder.withAadApplicationKeyAuthentication(`https://${clusterName}.kusto.windows.net`,'appid','appkey','authorityId');
+const kcsb = KustoConnectionStringBuilder.withAadApplicationKeyAuthentication(`https://${clusterName}.kusto.windows.net`, "appid", "appkey", "authorityId");
 const client = new KustoClient(kcsb);
 
 const results = await client.execute("db", "TableName | limit 1");
 console.log(JSON.stringify(results));
 console.log(results.primaryResults[0].toString());
-
 ```
 
 ## Authentication
+
 There are several authentication methods
 
 ### AAD application
+
 There are three ways to authenticate using AAD application:
 
 Option 1: Authenticating using AAD application id and corresponding key.
+
 ```javascript
-const kcsb = KustoConnectionStringBuilder.withAadApplicationKeyAuthentication(`https://${clusterName}.kusto.windows.net`,'appid','appkey','authorityId');
+const kcsb = KustoConnectionStringBuilder.withAadApplicationKeyAuthentication(`https://${clusterName}.kusto.windows.net`, "appid", "appkey", "authorityId");
 ```
 
 Option 2: Authenticating using AAD application id and corresponding certificate.
 
 ```javascript
-const kcsb = KustoConnectionStringBuilder.withAadApplicationCertificateAuthentication(`https://${clusterName}.kusto.windows.net`, 'appid', 'certificate', 'thumbprint', 'authorityId');
+const kcsb = KustoConnectionStringBuilder.withAadApplicationCertificateAuthentication(
+    `https://${clusterName}.kusto.windows.net`,
+    "appid",
+    "certificate",
+    "thumbprint",
+    "authorityId"
+);
 ```
 
 Option 3: Authenticating using [AAD Managed Identities](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview).
 
 ```javascript
-const kcsb = KustoConnectionStringBuilder.withAadManagedIdentities(`https://${clusterName}.kusto.windows.net`, '(Optional)msiEndpoint', '(Optional)clientId');
+const kcsb = KustoConnectionStringBuilder.withAadManagedIdentities(`https://${clusterName}.kusto.windows.net`, "(Optional)msiEndpoint", "(Optional)clientId");
 ```
 
-
 ### Username/Password
+
 ```javascript
-KustoConnectionStringBuilder.withAadUserPasswordAuthentication(`https://${clusterName}.kusto.windows.net`,'username','password');
+KustoConnectionStringBuilder.withAadUserPasswordAuthentication(`https://${clusterName}.kusto.windows.net`, "username", "password");
 ```
 
-Authority is optional *when it can inferred from the domain* ('user@microsoft.com' would make the authority 'microsoft.com'). 
+Authority is optional _when it can inferred from the domain_ ('user@microsoft.com' would make the authority 'microsoft.com').
 In any case it is possible to pass the authority id
+
 ```javascript
-KustoConnectionStringBuilder.withAadUserPasswordAuthentication(`https://${clusterName}.kusto.windows.net`,'username','password','authorityId');
+KustoConnectionStringBuilder.withAadUserPasswordAuthentication(`https://${clusterName}.kusto.windows.net`, "username", "password", "authorityId");
 ```
 
 ### Device
-Using this method will write a token to the console, which can be used to authenticate at https://login.microsoftonline.com/common/oauth2/deviceauth and will allow temporary access. 
+
+Using this method will write a token to the console, which can be used to authenticate at https://login.microsoftonline.com/common/oauth2/deviceauth and will allow temporary access.
 
 **<!>It is not meant for production purposes<!>**
 
@@ -71,7 +81,24 @@ KustoConnectionStringBuilder.withAadDeviceAuthentication(`https://${clusterName}
 });
 ```
 
+### Az Login
+
+You will need to [install the azure-cli](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) and run the following command:
+
+```bash
+az login
+```
+
+This method uses the token stored in azure cli for authentication.
+
+**<!>This is not recommeneded for unattended authentication<!>**
+
+```javascript
+const kcsb = KustoConnectionStringBuilder.withAzLoginIdentity(`https://${clusterName}.kusto.windows.net`); // optionally also pass authorityId
+```
+
 ## Usage
+
 Query language docs can be found at https://docs.microsoft.com/en-us/azure/data-explorer/write-queries#overview-of-the-query-language
 
 ## Advanced Usage
@@ -96,4 +123,3 @@ const results = await client.executeQuery("db", query, clientRequestProps);
 ```
 
 A full list of those properties can be found at https://docs.microsoft.com/en-us/azure/kusto/api/netfx/request-properties
-

package/example.js

@@ -4,7 +4,7 @@
 const KustoClient = require("azure-kusto-data").Client;
 const KustoConnectionStringBuilder = require("azure-kusto-data").KustoConnectionStringBuilder;
 const ClientRequestProperties = require("azure-kusto-data").ClientRequestProperties;
-const { v4: uuidv4 } = require('uuid');
+const { v4: uuidv4 } = require("uuid");
 
 const clusterConectionString = "https://<cluster>.<region>.kusto.windows.net";
 const database = "<databaseName>";
@@ -19,8 +19,7 @@ async function start() {
         const results = await kustoClient.execute(database, `['${table}'] | limit 1`);
         console.log(JSON.stringify(results));
         console.log(results.primaryResults[0].toString());
-    }
-    catch (error) {
+    } catch (error) {
         console.log(error);
     }
 
@@ -41,8 +40,7 @@ async function start() {
         const results = await kustoClient.execute(database, `['${table}'] | limit 1`, clientRequestProps);
         console.log(JSON.stringify(results));
         console.log(results.primaryResults[0].toString());
-    }
-    catch (error) {
+    } catch (error) {
         console.log(error);
     }
 }

package/index.js

@@ -1,5 +1,4 @@
 "use strict";
-/* tslint:disable:no-var-requires */
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 var __importDefault = (this && this.__importDefault) || function (mod) {

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA,oCAAoC;AACpC,uCAAuC;AACvC,kCAAkC;;;;;;AAElC,6DAA0C;AAKvB,iBALZ,gBAAW,CAKO;AAJzB,+FAAuE;AAKnE,kCALG,iCAAuB,CAKH;AAJ3B,mFAAsE;AAKlE,uCALG,2BAA4B,CAKH"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;AAElC,6DAA0C;AAIlB,iBAJjB,gBAAW,CAIY;AAH9B,+FAAuE;AAGvC,kCAHzB,iCAAuB,CAGyB;AAFvD,mFAAsE;AAEb,uCAFlD,2BAA4B,CAEkD"}

package/package.json

@@ -1,52 +1,65 @@
 {
-  "name": "azure-kusto-data",
-  "version": "2.2.3",
-  "description": "Azure Data Explorer Query SDK",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "engines": {
-    "node": ">= 8.0.0"
-  },
-  "tags": [
-    "azure",
-    "kusto",
-    "sdk"
-  ],
-  "keywords": [
-    "node",
-    "azure",
-    "kusto"
-  ],
-  "scripts": {
-    "build": "tsc -b",
-    "prepublish": "npm run build ",
-    "example": "npm run build && node example.js",
-    "lint": "npm run build && tslint --project tsconfig.json --quiet",
-    "test": "npm run build && mocha --require ts-node/register"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Azure/azure-kusto-node.git",
-    "directory": "azure-kusto-data"
-  },
-  "author": "",
-  "license": "ISC",
-  "homepage": "https://github.com/Azure/azure-kusto-node/blob/master/azure-kusto-data/README.md",
-  "dependencies": {
-    "@azure/identity": "^1.3.0",
-    "@azure/msal-node": "^1.1.0",
-    "@types/node": "^14.14.13",
-    "@types/uuid": "^8.3.0",
-    "axios": "^0.21.2",
-    "moment": "^2.25.3",
-    "uuid": "^8.3.2"
-  },
-  "devDependencies": {
-    "@types/mocha": "^8.2.0",
-    "mocha": "^7.1.2",
-    "sinon": "^7.2.3",
-    "tslint": "^6.1.3",
-    "typescript": "^4.1.3",
-    "ts-node": "^9.1.1"
-  }
+    "name": "azure-kusto-data",
+    "version": "3.2.0",
+    "description": "Azure Data Explorer Query SDK",
+    "main": "index.js",
+    "types": "index.d.ts",
+    "engines": {
+        "node": ">= 14.0.0"
+    },
+    "tags": [
+        "azure",
+        "kusto",
+        "sdk"
+    ],
+    "keywords": [
+        "node",
+        "azure",
+        "kusto"
+    ],
+    "scripts": {
+        "build": "tsc -b",
+        "prepublish": "npm run build ",
+        "example": "npm run build && node example.js",
+        "lint": "npx eslint -c .eslintrc.js --ext .ts .",
+        "test": "npm run build && mocha --parallel",
+        "testPipeline": "npm run build && nyc --reporter lcovonly mocha --reporter mocha-junit-reporter",
+        "format": "npx prettier --write .",
+        "checkFormat": "npx prettier --check --end-of-line lf ."
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Azure/azure-kusto-node.git",
+        "directory": "azure-kusto-data"
+    },
+    "author": "",
+    "license": "ISC",
+    "homepage": "https://github.com/Azure/azure-kusto-node/blob/master/azure-kusto-data/README.md",
+    "dependencies": {
+        "@azure/identity": "^2.0.1",
+        "@azure/msal-node": "^1.5.0",
+        "@types/node": "^14.14.13",
+        "@types/uuid": "^8.3.0",
+        "axios": "^0.24.0",
+        "follow-redirects": "^1.14.8",
+        "moment": "^2.25.3",
+        "uuid": "^8.3.2"
+    },
+    "devDependencies": {
+        "@types/mocha": "^8.2.0",
+        "@typescript-eslint/eslint-plugin": "^5.12.0",
+        "@typescript-eslint/parser": "^5.12.0",
+        "eslint": "^8.9.0",
+        "eslint-config-prettier": "^8.3.0",
+        "eslint-plugin-header": "^3.1.1",
+        "eslint-plugin-jsdoc": "^37.9.1",
+        "eslint-plugin-prefer-arrow": "^1.2.3",
+        "mocha": "^9.2.0",
+        "mocha-junit-reporter": "^2.0.2",
+        "nyc": "^15.1.0",
+        "prettier": "2.5.1",
+        "sinon": "^7.2.3",
+        "ts-node": "^9.1.1",
+        "typescript": "^4.1.3"
+    }
 }

package/source/client.d.ts

@@ -12,21 +12,23 @@ declare enum ExecutionType {
 export declare class KustoClient {
     connectionString: ConnectionStringBuilder;
     cluster: string;
+    defaultDatabase?: string;
     endpoints: {
         [key in ExecutionType]: string;
     };
     aadHelper: AadHelper;
     axiosInstance: AxiosInstance;
     constructor(kcsb: string | ConnectionStringBuilder);
-    execute(db: string, query: string, properties?: ClientRequestProperties): Promise<KustoResponseDataSet>;
-    executeQuery(db: string, query: string, properties?: ClientRequestProperties): Promise<KustoResponseDataSet>;
-    executeQueryV1(db: string, query: string, properties?: ClientRequestProperties): Promise<KustoResponseDataSet>;
-    executeMgmt(db: string, query: string, properties?: ClientRequestProperties): Promise<KustoResponseDataSet>;
-    executeStreamingIngest(db: string, table: string, stream: any, streamFormat: any, mappingName: string | null): Promise<KustoResponseDataSet>;
-    _execute(endpoint: string, executionType: ExecutionType, db: string, query: string | null, stream: string | null, properties?: ClientRequestProperties | null): Promise<KustoResponseDataSet>;
+    execute(db: string | null, query: string, properties?: ClientRequestProperties): Promise<KustoResponseDataSet>;
+    executeQuery(db: string | null, query: string, properties?: ClientRequestProperties): Promise<KustoResponseDataSet>;
+    executeQueryV1(db: string | null, query: string, properties?: ClientRequestProperties): Promise<KustoResponseDataSet>;
+    executeMgmt(db: string | null, query: string, properties?: ClientRequestProperties): Promise<KustoResponseDataSet>;
+    executeStreamingIngest(db: string | null, table: string, stream: any, streamFormat: any, mappingName: string | null, clientRequestId?: string): Promise<KustoResponseDataSet>;
+    _execute(endpoint: string, executionType: ExecutionType, db: string | null, query: string | null, stream: any, properties?: ClientRequestProperties | null): Promise<KustoResponseDataSet>;
+    private getDb;
     _doRequest(endpoint: string, executionType: ExecutionType, headers: {
         [header: string]: string;
-    }, payload: string, timeout: number, properties?: ClientRequestProperties | null): Promise<KustoResponseDataSet>;
+    }, payload: any, timeout: number, properties?: ClientRequestProperties | null): Promise<KustoResponseDataSet>;
     _parseResponse(response: any, executionType: ExecutionType, properties?: ClientRequestProperties | null, status?: number): KustoResponseDataSet;
     _getClientTimeout(executionType: ExecutionType, properties?: ClientRequestProperties | null): number;
 }