azure-kusto-data 3.3.1 → 3.4.1

package/README.md

@@ -13,6 +13,7 @@ const KustoConnectionStringBuilder = require("azure-kusto-data").KustoConnection
 const kcsb = KustoConnectionStringBuilder.withAadApplicationKeyAuthentication(`https://${clusterName}.kusto.windows.net`, "appid", "appkey", "authorityId");
 const client = new KustoClient(kcsb);
 
+// `execute()` infers the type of command from the query, although you can also specify the type explicitly using the methods `excuteQuery()`,`executeQueryV1()` or `executeMgmt()`
 const results = await client.execute("db", "TableName | limit 1");
 console.log(JSON.stringify(results));
 console.log(results.primaryResults[0].toString());
@@ -47,7 +48,8 @@ const kcsb = KustoConnectionStringBuilder.withAadApplicationCertificateAuthentic
 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.withSystemManagedIdentity(`https://${clusterName}.kusto.windows.net`);
+const kcsb = KustoConnectionStringBuilder.withUserManagedIdentity(`https://${clusterName}.kusto.windows.net`, clientId);
 ```
 
 ### Username/Password

package/example.js

@@ -37,6 +37,7 @@ async function start() {
     clientRequestProps.clientRequestId = `MyApp.MyActivity;${uuidv4()}`;
 
     try {
+        // `execute()` infers the type of command from the query, although you can also specify the type explicitly using the methods `excuteQuery()`,`executeQueryV1()` or `executeMgmt()`
         const results = await kustoClient.execute(database, `['${table}'] | limit 1`, clientRequestProps);
         console.log(JSON.stringify(results));
         console.log(results.primaryResults[0].toString());

package/index.d.ts

@@ -1,4 +1,5 @@
 import KustoClient from "./source/client";
 import ClientRequestProperties from "./source/clientRequestProperties";
 import KustoConnectionStringBuilder from "./source/connectionBuilder";
-export { KustoClient as Client, ClientRequestProperties, KustoConnectionStringBuilder };
+import * as KustoDataErrors from "./source/errors";
+export { KustoClient as Client, ClientRequestProperties, KustoConnectionStringBuilder, KustoDataErrors };

package/index.js

@@ -1,15 +1,40 @@
 "use strict";
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KustoConnectionStringBuilder = exports.ClientRequestProperties = exports.Client = void 0;
+exports.KustoDataErrors = exports.KustoConnectionStringBuilder = exports.ClientRequestProperties = exports.Client = void 0;
 const client_1 = __importDefault(require("./source/client"));
 exports.Client = client_1.default;
 const clientRequestProperties_1 = __importDefault(require("./source/clientRequestProperties"));
 exports.ClientRequestProperties = clientRequestProperties_1.default;
 const connectionBuilder_1 = __importDefault(require("./source/connectionBuilder"));
 exports.KustoConnectionStringBuilder = connectionBuilder_1.default;
+const KustoDataErrors = __importStar(require("./source/errors"));
+exports.KustoDataErrors = KustoDataErrors;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,12 +1,18 @@
 {
     "name": "azure-kusto-data",
-    "version": "3.3.1",
+    "version": "3.4.1",
     "description": "Azure Data Explorer Query SDK",
     "main": "index.js",
     "types": "index.d.ts",
+    "scripts": {
+        "build": "tsc"
+    },
     "engines": {
         "node": ">= 14.0.0"
     },
+    "publishConfig": {
+        "access": "public"
+    },
     "tags": [
         "azure",
         "kusto",
@@ -17,33 +23,32 @@
         "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"
     },
+    "files": [
+        "source/**/*.js",
+        "source/**/*.d.ts",
+        "index.js",
+        "index.d.ts",
+        "tsconfig.tsbuildinfo",
+        "example.js"
+    ],
     "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",
+        "@azure/identity": "^2.1.0",
+        "@azure/msal-node": "^1.12.1",
+        "@types/node": "^18.6.4",
+        "@types/uuid": "^8.3.4",
+        "axios": "^0.27.2",
+        "follow-redirects": "^1.15.1",
+        "moment": "^2.29.4",
+        "ts-node": "^10.9.1",
         "uuid": "^8.3.2"
     },
-    "gitHead": "a4760ed3302ffa6ec772107fb6346c0ad2bb1453"
+    "gitHead": "9677e7be6186f9a5bf2ce12245662640fb10c6db"
 }

package/source/client.js

@@ -21,6 +21,7 @@ const security_1 = __importDefault(require("./security"));
 const response_1 = require("./response");
 const connectionBuilder_1 = __importDefault(require("./connectionBuilder"));
 const clientRequestProperties_1 = __importDefault(require("./clientRequestProperties"));
+const errors_1 = require("./errors");
 const package_json_1 = __importDefault(require("../package.json"));
 const axios_1 = __importDefault(require("axios"));
 const http_1 = __importDefault(require("http"));
@@ -39,7 +40,11 @@ var ExecutionType;
 class KustoClient {
     constructor(kcsb) {
         this.connectionString = typeof kcsb === "string" ? new connectionBuilder_1.default(kcsb) : kcsb;
-        this.cluster = this.connectionString.dataSource;
+        if (!this.connectionString.dataSource) {
+            throw new Error("Cluster url is required");
+        }
+        const url = new URL(this.connectionString.dataSource);
+        this.cluster = `${url.protocol}//${url.hostname}${url.port ? `:${url.port}` : ""}`;
         this.defaultDatabase = this.connectionString.initialCatalog;
         this.endpoints = {
             [ExecutionType.Mgmt]: `${this.cluster}/v1/rest/mgmt`,
@@ -157,7 +162,6 @@ class KustoClient {
         return db;
     }
     _doRequest(endpoint, executionType, headers, payload, timeout, properties) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const axiosConfig = {
                 headers,
@@ -169,8 +173,9 @@ class KustoClient {
             }
             catch (error) {
                 if (axios_1.default.isAxiosError(error) && error.response) {
-                    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-                    throw ((_a = error.response.data) === null || _a === void 0 ? void 0 : _a.error) || error.response.data;
+                    if (error.response.status === 429) {
+                        throw new errors_1.ThrottlingError("POST request failed with status 429 (Too Many Requests)", error);
+                    }
                 }
                 throw error;
             }

package/source/clientRequestProperties.js

@@ -55,13 +55,13 @@ class ClientRequestProperties {
     toJSON() {
         const json = {};
         if (Object.keys(this._options).length !== 0) {
-            json.Options = this._options;
+            json.Options = Object.assign({}, this._options);
             if (json.Options.servertimeout) {
                 json.Options.servertimeout = this._msToTimespan(json.Options.servertimeout);
             }
         }
         if (Object.keys(this._parameters).length !== 0) {
-            json.Parameters = this._parameters;
+            json.Parameters = Object.assign({}, this._parameters);
         }
         return Object.keys(json).length !== 0 ? json : null;
     }

package/source/connectionBuilder.d.ts

@@ -31,7 +31,12 @@ export declare class KustoConnectionStringBuilder {
     static withAadApplicationKeyAuthentication(connectionString: string, aadAppId: string, appKey: string, authorityId?: string): KustoConnectionStringBuilder;
     static withAadApplicationCertificateAuthentication(connectionString: string, aadAppId: string, applicationCertificatePrivateKey: string, applicationCertificateThumbprint: string, authorityId?: string, applicationCertificateX5c?: string): KustoConnectionStringBuilder;
     static withAadDeviceAuthentication(connectionString: string, authorityId?: string, deviceCodeCallback?: (response: DeviceCodeResponse) => void): KustoConnectionStringBuilder;
+    /**
+     * @deprecated - use `withSystemManagedIdentity` or `withUserManagedIdentity` instead
+     */
     static withAadManagedIdentities(connectionString: string, msiClientId?: string, authorityId?: string, timeoutMs?: number): KustoConnectionStringBuilder;
+    static withSystemManagedIdentity(connectionString: string, authorityId?: string, timeoutMs?: number): KustoConnectionStringBuilder;
+    static withUserManagedIdentity(connectionString: string, msiClientId: string, authorityId?: string, timeoutMs?: number): KustoConnectionStringBuilder;
     static withAzLoginIdentity(connectionString: string, authorityId?: string, timeoutMs?: number): KustoConnectionStringBuilder;
     static withAccessToken(connectionString: string, accessToken: string): KustoConnectionStringBuilder;
     static withTokenProvider(connectionString: string, tokenProvider: () => Promise<string>): KustoConnectionStringBuilder;

package/source/connectionBuilder.js

@@ -69,7 +69,7 @@ const getPropName = (key) => {
 class KustoConnectionStringBuilder {
     constructor(connectionString) {
         var _a;
-        this.authorityId = "common";
+        this.authorityId = "organizations";
         if (connectionString.trim().length === 0)
             throw new Error("Missing connection string");
         if (connectionString.endsWith("/") || connectionString.endsWith("\\")) {
@@ -157,14 +157,19 @@ class KustoConnectionStringBuilder {
         }
         return kcsb;
     }
-    static withAadDeviceAuthentication(connectionString, authorityId = "common", deviceCodeCallback = KustoConnectionStringBuilder.defaultDeviceCallback) {
+    static withAadDeviceAuthentication(connectionString, authorityId, deviceCodeCallback = KustoConnectionStringBuilder.defaultDeviceCallback) {
         const kcsb = new KustoConnectionStringBuilder(connectionString);
         kcsb.aadFederatedSecurity = true;
-        kcsb.authorityId = authorityId;
+        if (authorityId) {
+            kcsb.authorityId = authorityId;
+        }
         kcsb.deviceCodeCallback = deviceCodeCallback;
         kcsb.useDeviceCodeAuth = true;
         return kcsb;
     }
+    /**
+     * @deprecated - use `withSystemManagedIdentity` or `withUserManagedIdentity` instead
+     */
     static withAadManagedIdentities(connectionString, msiClientId, authorityId, timeoutMs) {
         const kcsb = new KustoConnectionStringBuilder(connectionString);
         kcsb.aadFederatedSecurity = true;
@@ -176,6 +181,12 @@ class KustoConnectionStringBuilder {
         kcsb.useManagedIdentityAuth = true;
         return kcsb;
     }
+    static withSystemManagedIdentity(connectionString, authorityId, timeoutMs) {
+        return this.withAadManagedIdentities(connectionString, undefined, authorityId, timeoutMs);
+    }
+    static withUserManagedIdentity(connectionString, msiClientId, authorityId, timeoutMs) {
+        return this.withAadManagedIdentities(connectionString, msiClientId, authorityId, timeoutMs);
+    }
     static withAzLoginIdentity(connectionString, authorityId, timeoutMs) {
         const kcsb = new KustoConnectionStringBuilder(connectionString);
         kcsb.aadFederatedSecurity = true;

package/source/errors.d.ts

@@ -4,3 +4,7 @@ export declare class KustoAuthenticationError extends Error {
     context: Record<string, any>;
     constructor(message: string, inner: Error | undefined, tokenProviderName: string, context: Record<string, any>);
 }
+export declare class ThrottlingError extends Error {
+    inner: Error | undefined;
+    constructor(message: string, inner: Error | undefined);
+}

package/source/errors.js

@@ -2,7 +2,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.KustoAuthenticationError = void 0;
+exports.ThrottlingError = exports.KustoAuthenticationError = void 0;
 class KustoAuthenticationError extends Error {
     constructor(message, inner, tokenProviderName, context) {
         super(message);
@@ -13,4 +13,12 @@ class KustoAuthenticationError extends Error {
     }
 }
 exports.KustoAuthenticationError = KustoAuthenticationError;
+class ThrottlingError extends Error {
+    constructor(message, inner) {
+        super(message);
+        this.inner = inner;
+        this.name = "ThrottlingError";
+    }
+}
+exports.ThrottlingError = ThrottlingError;
 //# sourceMappingURL=errors.js.map

package/source/models.js

@@ -6,8 +6,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KustoResultTable = exports.KustoResultColumn = exports.KustoResultRow = exports.WellKnownDataSet = void 0;
-// We want all the Kusto table models in this file
-/* eslint-disable max-classes-per-file */
 const moment_1 = __importDefault(require("moment"));
 var WellKnownDataSet;
 (function (WellKnownDataSet) {

package/source/response.js

@@ -3,8 +3,6 @@
 // Licensed under the MIT License.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.KustoResponseDataSetV2 = exports.KustoResponseDataSetV1 = exports.KustoResponseDataSet = void 0;
-// We want all the Response models to be in this file
-/* eslint-disable max-classes-per-file */
 const models_1 = require("./models");
 var ErrorLevels;
 (function (ErrorLevels) {

package/source/security.js

@@ -51,16 +51,16 @@ class AadHelper {
             this.tokenProvider = new TokenProvider.ApplicationCertificateTokenProvider(kcsb.dataSource, kcsb.applicationClientId, kcsb.applicationCertificateThumbprint, kcsb.applicationCertificatePrivateKey, kcsb.applicationCertificateX5c, kcsb.authorityId);
         }
         else if (kcsb.useManagedIdentityAuth) {
-            this.tokenProvider = new TokenProvider.MsiTokenProvider(kcsb.dataSource, kcsb.authorityId, kcsb.msiClientId, kcsb.timeoutMs);
+            this.tokenProvider = new TokenProvider.MsiTokenProvider(kcsb.dataSource, kcsb.msiClientId, kcsb.authorityId, kcsb.timeoutMs);
         }
         else if (kcsb.useAzLoginAuth) {
-            this.tokenProvider = new TokenProvider.AzCliTokenProvider(kcsb.dataSource, kcsb.authorityId, undefined, kcsb.timeoutMs);
+            this.tokenProvider = new TokenProvider.AzCliTokenProvider(kcsb.dataSource, kcsb.authorityId, kcsb.timeoutMs);
         }
         else if (kcsb.accessToken) {
             this.tokenProvider = new TokenProvider.BasicTokenProvider(kcsb.dataSource, kcsb.accessToken);
         }
         else if (kcsb.useUserPromptAuth) {
-            this.tokenProvider = new TokenProvider.UserPromptProvider(kcsb.dataSource, kcsb.authorityId, kcsb.applicationClientId, kcsb.timeoutMs, kcsb.loginHint);
+            this.tokenProvider = new TokenProvider.UserPromptProvider(kcsb.dataSource, kcsb.authorityId, kcsb.timeoutMs, kcsb.loginHint);
         }
         else if (kcsb.tokenProvider) {
             this.tokenProvider = new TokenProvider.CallbackTokenProvider(kcsb.dataSource, kcsb.tokenProvider);

package/source/tokenProvider.d.ts

@@ -1,4 +1,4 @@
-import { ConfidentialClientApplication, PublicClientApplication } from "@azure/msal-node";
+import { ConfidentialClientApplication, Configuration, PublicClientApplication } from "@azure/msal-node";
 import { DeviceCodeResponse } from "@azure/msal-common";
 import { CloudInfo } from "./cloudSettings";
 import { TokenCredential } from "@azure/core-auth";
@@ -38,32 +38,38 @@ export declare class CallbackTokenProvider extends TokenProviderBase {
     acquireToken(): Promise<TokenResponse>;
 }
 /**
- * Acquire a token from MSAL
+ * Token providers that require cloud settings to be configured - msal and azure identity
  */
-declare abstract class MsalTokenProvider extends TokenProviderBase {
-    cloudInfo: CloudInfo;
-    authorityId: string;
-    initialized: boolean;
-    authorityUri: string;
+declare abstract class CloudSettingsTokenProvider extends TokenProviderBase {
+    protected cloudInfo: CloudInfo;
+    protected initialized: boolean;
     abstract initClient(): void;
-    abstract acquireMsalToken(): Promise<TokenType | null>;
-    protected constructor(kustoUri: string, authorityId: string);
+    abstract acquireTokenWithCloudSettings(): Promise<TokenType | null>;
+    additionalCloudSettingsInit(): void;
+    protected constructor(kustoUri: string);
     acquireToken(): Promise<TokenResponse>;
     context(): Record<string, any>;
 }
-export declare abstract class AzureIdentityProvider extends MsalTokenProvider {
-    protected clientId?: string | undefined;
+/**
+ * Acquire a token from MSAL
+ */
+declare abstract class MsalTokenProvider extends CloudSettingsTokenProvider {
+    private clientId;
+    protected cloudInfo: CloudInfo;
+    protected authorityId: string;
+    protected authorityUri: string;
+    protected constructor(kustoUri: string, authorityId: string, clientId: string | undefined);
+    commonOptions(): Configuration;
+    additionalCloudSettingsInit(): void;
+    context(): Record<string, any>;
+}
+export declare abstract class AzureIdentityProvider extends CloudSettingsTokenProvider {
+    protected authorityId?: string | undefined;
     private timeoutMs?;
     private credential;
-    protected authorityHost: string;
-    constructor(kustoUri: string, authorityId: string, clientId?: string | undefined, timeoutMs?: number | undefined);
+    constructor(kustoUri: string, authorityId?: string | undefined, timeoutMs?: number | undefined);
     initClient(): void;
-    getCommonOptions(): {
-        authorityHost: string;
-        clientId: string | undefined;
-        tenantId: string;
-    };
-    acquireMsalToken(): Promise<TokenType | null>;
+    acquireTokenWithCloudSettings(): Promise<TokenType | null>;
     context(): Record<string, any>;
     abstract getCredential(): TokenCredential;
 }
@@ -72,7 +78,10 @@ export declare abstract class AzureIdentityProvider extends MsalTokenProvider {
  * The args parameter is a dictionary conforming with the ManagedIdentityCredential initializer API arguments
  */
 export declare class MsiTokenProvider extends AzureIdentityProvider {
+    protected clientId?: string | undefined;
+    constructor(kustoUri: string, clientId?: string | undefined, authorityId?: string, timeoutMs?: number);
     getCredential(): TokenCredential;
+    context(): Record<string, any>;
 }
 /**
  * AzCli Token Provider obtains a refresh token from the AzCli cache and uses it to authenticate with MSAL
@@ -85,9 +94,11 @@ export declare class AzCliTokenProvider extends AzureIdentityProvider {
  */
 export declare class UserPromptProvider extends AzureIdentityProvider {
     private loginHint?;
-    readonly BrowserPort = 23145;
-    constructor(kustoUri: string, authorityId: string, clientId?: string, timeoutMs?: number, loginHint?: string | undefined);
+    readonly MinPort = 20000;
+    readonly MaxPort = 65536;
+    constructor(kustoUri: string, authorityId: string, timeoutMs?: number, loginHint?: string | undefined);
     getCredential(): TokenCredential;
+    private getRandomPortInRange;
     context(): Record<string, any>;
 }
 /**
@@ -100,7 +111,7 @@ export declare class UserPassTokenProvider extends MsalTokenProvider {
     msalClient: PublicClientApplication;
     constructor(kustoUri: string, userName: string, password: string, authorityId: string);
     initClient(): void;
-    acquireMsalToken(): Promise<TokenType | null>;
+    acquireTokenWithCloudSettings(): Promise<TokenType | null>;
     context(): Record<string, any>;
 }
 /**
@@ -112,18 +123,18 @@ export declare class DeviceLoginTokenProvider extends MsalTokenProvider {
     msalClient: PublicClientApplication;
     constructor(kustoUri: string, deviceCodeCallback: (response: DeviceCodeResponse) => void, authorityId: string);
     initClient(): void;
-    acquireMsalToken(): Promise<TokenType | null>;
+    acquireTokenWithCloudSettings(): Promise<TokenType | null>;
 }
 /**
- * Acquire a token from MSAL with application Id and Key
+ * Acquire a token from MSAL with application id and Key
  */
 export declare class ApplicationKeyTokenProvider extends MsalTokenProvider {
-    appClientId: string;
-    appKey: string;
+    private appClientId;
+    private appKey;
     msalClient: ConfidentialClientApplication;
     constructor(kustoUri: string, appClientId: string, appKey: string, authorityId: string);
     initClient(): void;
-    acquireMsalToken(): Promise<TokenType | null>;
+    acquireTokenWithCloudSettings(): Promise<TokenType | null>;
     context(): Record<string, any>;
 }
 /**
@@ -131,14 +142,14 @@ export declare class ApplicationKeyTokenProvider extends MsalTokenProvider {
  * Passing the public certificate is optional and will result in Subject Name & Issuer Authentication
  */
 export declare class ApplicationCertificateTokenProvider extends MsalTokenProvider {
-    appClientId: string;
-    certThumbprint: string;
-    certPrivateKey: string;
-    certX5c?: string;
+    private appClientId;
+    private certThumbprint;
+    private certPrivateKey;
+    private certX5c?;
     msalClient: ConfidentialClientApplication;
-    constructor(kustoUri: string, appClientId: string, certThumbprint: string, certPrivateKey: string, certX5c?: string, authorityId?: string);
+    constructor(kustoUri: string, appClientId: string, certThumbprint: string, certPrivateKey: string, certX5c?: string | undefined, authorityId?: string);
     initClient(): void;
-    acquireMsalToken(): Promise<TokenType | null>;
+    acquireTokenWithCloudSettings(): Promise<TokenType | null>;
     context(): Record<string, any>;
 }
 export {};