@salesforce/analytics 0.23.0 → 1.0.2

package/lib/lib/analytics/dataset/dataset.js

@@ -0,0 +1,82 @@
+"use strict";
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchFieldNames = void 0;
+const core_1 = require("@salesforce/core");
+const request_1 = require("../request");
+class DatasetSvc {
+    constructor(connection) {
+        this.connection = connection;
+        this.datasetsUrl = `${this.connection.baseUrl()}/wave/datasets`;
+    }
+    list() {
+        return request_1.fetchAllPages(this.connection, this.datasetsUrl, 'datasets');
+    }
+    async fetch(idOrApiName) {
+        const response = await request_1.connectRequest(this.connection, this.datasetsUrl + '/' + encodeURIComponent(idOrApiName));
+        if (response) {
+            return response;
+        }
+        else {
+            throw new core_1.SfdxError('Missing response');
+        }
+    }
+    async fetchXmd(idOrApiName, versionId, xmdType = 'main') {
+        const xmd = await request_1.connectRequest(this.connection, this.datasetsUrl +
+            '/' +
+            encodeURIComponent(idOrApiName) +
+            '/versions/' +
+            encodeURIComponent(versionId) +
+            `/xmds/${xmdType}`);
+        if (xmd) {
+            return xmd;
+        }
+        else {
+            throw new core_1.SfdxError('Missing response');
+        }
+    }
+    /** Fetch the queryable field names from the specified dataset version */
+    async fetchFieldNames(idOrApiName, versionId) {
+        const xmd = await this.fetchXmd(idOrApiName, versionId, 'main');
+        return fetchFieldNames(xmd);
+    }
+    /** Fetch the field names for the specified external connector dataset. */
+    async fetchLiveDatasetFieldNames(connectorIdOrApiName, sourceObjectName) {
+        const { fields } = await request_1.connectRequest(this.connection, `${this.connection.baseUrl()}/wave/dataConnectors/${encodeURIComponent(connectorIdOrApiName)}/sourceObjects/${encodeURIComponent(sourceObjectName)}/fields`);
+        if (Array.isArray(fields)) {
+            return fields.map(f => f.name).filter(n => !!n);
+        }
+        else {
+            throw new core_1.SfdxError(`Missing fields for ${connectorIdOrApiName}/${sourceObjectName}`);
+        }
+    }
+}
+exports.default = DatasetSvc;
+/** Fetch the queryable field names from the specified xmd. */
+function fetchFieldNames(xmd) {
+    var _a, _b, _c;
+    const fieldsFromDates = (_a = xmd.dates) === null || _a === void 0 ? void 0 : _a.map(d => d.fields);
+    const fieldNames = [];
+    [...(((_b = xmd.dimensions) === null || _b === void 0 ? void 0 : _b.map(dim => dim.field)) || []), ...(((_c = xmd.measures) === null || _c === void 0 ? void 0 : _c.map(measure => measure.field)) || [])].forEach(fieldName => {
+        if (!fieldName) {
+            return;
+        }
+        // it's the original field
+        if (fieldsFromDates === null || fieldsFromDates === void 0 ? void 0 : fieldsFromDates.map(d => d === null || d === void 0 ? void 0 : d.fullField).includes(fieldName)) {
+            fieldNames.push(fieldName);
+            return;
+        }
+        const isDerived = fieldsFromDates === null || fieldsFromDates === void 0 ? void 0 : fieldsFromDates.some(d => d && Object.values(d).includes(fieldName));
+        if (!isDerived) {
+            fieldNames.push(fieldName);
+        }
+    });
+    return fieldNames;
+}
+exports.fetchFieldNames = fetchFieldNames;
+//# sourceMappingURL=dataset.js.map

package/lib/lib/analytics/dataset/dataset.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataset.js","sourceRoot":"","sources":["../../../../src/lib/analytics/dataset/dataset.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,2CAAyD;AACzD,wCAA2D;AAkD3D,MAAqB,UAAU;IAG7B,YAAoC,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;QACxD,IAAI,CAAC,WAAW,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,gBAAgB,CAAC;IAClE,CAAC;IAEM,IAAI;QACT,OAAO,uBAAa,CAAc,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IACnF,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,WAAmB;QACpC,MAAM,QAAQ,GAAG,MAAM,wBAAc,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,WAAW,GAAG,GAAG,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC;QACjH,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAuB,CAAC;SAChC;aAAM;YACL,MAAM,IAAI,gBAAS,CAAC,kBAAkB,CAAC,CAAC;SACzC;IACH,CAAC;IAEM,KAAK,CAAC,QAAQ,CACnB,WAAmB,EACnB,SAAiB,EACjB,UAAgD,MAAM;QAEtD,MAAM,GAAG,GAAG,MAAM,wBAAc,CAC9B,IAAI,CAAC,UAAU,EACf,IAAI,CAAC,WAAW;YACd,GAAG;YACH,kBAAkB,CAAC,WAAW,CAAC;YAC/B,YAAY;YACZ,kBAAkB,CAAC,SAAS,CAAC;YAC7B,SAAS,OAAO,EAAE,CACrB,CAAC;QACF,IAAI,GAAG,EAAE;YACP,OAAO,GAAG,CAAC;SACZ;aAAM;YACL,MAAM,IAAI,gBAAS,CAAC,kBAAkB,CAAC,CAAC;SACzC;IACH,CAAC;IAED,yEAAyE;IAClE,KAAK,CAAC,eAAe,CAAC,WAAmB,EAAE,SAAiB;QACjE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;QAChE,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;IAED,0EAA0E;IACnE,KAAK,CAAC,0BAA0B,CAAC,oBAA4B,EAAE,gBAAwB;QAC5F,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,wBAAc,CACrC,IAAI,CAAC,UAAU,EACf,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,wBAAwB,kBAAkB,CACpE,oBAAoB,CACrB,kBAAkB,kBAAkB,CAAC,gBAAgB,CAAC,SAAS,CACjE,CAAC;QACF,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;YACzB,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACjD;aAAM;YACL,MAAM,IAAI,gBAAS,CAAC,sBAAsB,oBAAoB,IAAI,gBAAgB,EAAE,CAAC,CAAC;SACvF;IACH,CAAC;CACF;AA7DD,6BA6DC;AAED,8DAA8D;AAC9D,SAAgB,eAAe,CAAC,GAAY;;IAC1C,MAAM,eAAe,GAAG,MAAA,GAAG,CAAC,KAAK,0CAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAEtD,MAAM,UAAU,GAAa,EAAE,CAAC;IAChC,CAAC,GAAG,CAAC,CAAA,MAAA,GAAG,CAAC,UAAU,0CAAE,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,KAAI,EAAE,CAAC,EAAE,GAAG,CAAC,CAAA,MAAA,GAAG,CAAC,QAAQ,0CAAE,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,KAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAChH,SAAS,CAAC,EAAE;QACV,IAAI,CAAC,SAAS,EAAE;YACd,OAAO;SACR;QACD,0BAA0B;QAC1B,IAAI,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC,EAAE;YAC/D,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC3B,OAAO;SACR;QACD,MAAM,SAAS,GAAG,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;QACxF,IAAI,CAAC,SAAS,EAAE;YACd,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC5B;IACH,CAAC,CACF,CAAC;IACF,OAAO,UAAU,CAAC;AACpB,CAAC;AArBD,0CAqBC"}

package/{dist → lib}/lib/analytics/event/waveAssetEvent.js

@@ -1,4 +1,10 @@
 "use strict";
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
 const ts_types_1 = require("@salesforce/ts-types");
 class WaveAssetEvent {

package/lib/lib/analytics/event/waveAssetEvent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"waveAssetEvent.js","sourceRoot":"","sources":["../../../../src/lib/analytics/event/waveAssetEvent.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,mDAA+D;AAE/D,MAAqB,cAAc;IAYjC,YAAmB,KAAc;QAC/B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,cAAG,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC;QACrD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,cAAG,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,cAAG,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC,CAAC;QACzD,IAAI,CAAC,KAAK,GAAG,oBAAS,CAAC,KAAK,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,cAAG,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,CAAC;QACvD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,cAAG,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,cAAG,CAAC,KAAK,EAAE,uBAAuB,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,KAAK,GAAG,oBAAS,CAAC,KAAK,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,cAAG,CAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC,CAAC;QACnD,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,cAAG,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC,CAAC;IACvD,CAAC;CACF;AAxBD,iCAwBC"}

package/{dist → lib}/lib/analytics/lens/lens.d.ts

@@ -7,6 +7,7 @@ export declare type LensHistoryType = {
 export declare type LensType = {
     id?: string;
     name?: string;
+    namespace?: string;
     label?: string;
 };
 export default class Lens {
@@ -16,5 +17,4 @@ export default class Lens {
     list(): Promise<LensType[]>;
     getHistories(lensId: string): Promise<LensHistoryType[]>;
     revertToHistory(lensId: string, historyId: string, historyLabel?: string): Promise<string | undefined>;
-    private throwError;
 }

package/{dist → lib}/lib/analytics/lens/lens.js

@@ -3,12 +3,11 @@
  * Copyright (c) 2016, salesforce.com, inc.
  * All rights reserved.
  * Licensed under the BSD 3-Clause license.
- * For full license text, see LICENSE.txt file in the repo root  or https://opensource.org/licenses/BSD-3-Clause
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-const core_1 = require("@salesforce/core");
-const _ = require("lodash");
 const request_1 = require("../request");
+const utils_1 = require("../utils");
 class Lens {
     constructor(organization) {
         this.connection = organization.getConnection();
@@ -38,15 +37,9 @@ class Lens {
             return (_a = response.asset) === null || _a === void 0 ? void 0 : _a.id;
         }
         else {
-            this.throwError(response);
+            utils_1.throwError(response);
         }
     }
-    throwError(response) {
-        // For Gacks, the error message is on response.body[0].message but for handled errors
-        // the error message is on response.body.Errors[0].description.
-        const errMessage = _.get(response, 'Errors[0].description') || _.get(response, '[0].message') || 'Unknown Error';
-        throw new core_1.SfdxError(errMessage);
-    }
 }
 exports.default = Lens;
 //# sourceMappingURL=lens.js.map

package/lib/lib/analytics/lens/lens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lens.js","sourceRoot":"","sources":["../../../../src/lib/analytics/lens/lens.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAGH,wCAA2D;AAC3D,oCAAsC;AAuBtC,MAAqB,IAAI;IAIvB,YAAmB,YAAiB;QAClC,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,CAAC;IAC/D,CAAC;IAEM,IAAI;QACT,OAAO,uBAAa,CAAW,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAC5E,CAAC;IAEM,YAAY,CAAC,MAAc;QAChC,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,GAAG,YAAY,CAAC;QAC9E,yGAAyG;QACzG,+GAA+G;QAC/G,OAAO,uBAAa,CAAkB,IAAI,CAAC,UAAU,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IAClF,CAAC;IAEM,KAAK,CAAC,eAAe,CAAC,MAAc,EAAE,SAAiB,EAAE,YAAqB;;QACnF,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;QAC1E,MAAM,QAAQ,GAAG,MAAM,wBAAc,CAAiB,IAAI,CAAC,UAAU,EAAE;YACrE,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,SAAS;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;gBACnB,SAAS;gBACT,YAAY;aACb,CAAC;SACH,CAAC,CAAC;QAEH,IAAI,QAAQ,EAAE;YACZ,OAAO,MAAA,QAAQ,CAAC,KAAK,0CAAE,EAAE,CAAC;SAC3B;aAAM;YACL,kBAAU,CAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC;CACF;AArCD,uBAqCC"}

package/{dist → lib}/lib/analytics/publisher/publisher.d.ts

@@ -16,5 +16,4 @@ export default class Publisher {
     list(assetId: string): Promise<PublisherType[] | undefined>;
     deleteAll(assetId: string): Promise<void>;
     delete(assetId: string, id: string): Promise<void>;
-    private throwError;
 }

package/{dist → lib}/lib/analytics/publisher/publisher.js

@@ -1,14 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-/*
- * Copyright (c) 2016, salesforce.com, inc.
- * All rights reserved.
- * Licensed under the BSD 3-Clause license.
- * For full license text, see LICENSE.txt file in the repo root  or https://opensource.org/licenses/BSD-3-Clause
- */
-const core_1 = require("@salesforce/core");
-const _ = require("lodash");
 const request_1 = require("../request");
+const utils_1 = require("../utils");
 class Publisher {
     constructor(organization) {
         this.connection = organization.getConnection();
@@ -25,7 +18,7 @@ class Publisher {
             return response.id;
         }
         else {
-            this.throwError(response);
+            utils_1.throwError(response);
         }
     }
     async list(assetId) {
@@ -37,27 +30,21 @@ class Publisher {
             return response.publishers;
         }
         else {
-            this.throwError(response);
+            utils_1.throwError(response);
         }
     }
-    async deleteAll(assetId) {
-        await request_1.connectRequest(this.connection, {
+    deleteAll(assetId) {
+        return request_1.connectRequest(this.connection, {
             method: 'DELETE',
             url: this.publishersUrl + assetId + '/' + this.endpointName
         });
     }
-    async delete(assetId, id) {
-        await request_1.connectRequest(this.connection, {
+    delete(assetId, id) {
+        return request_1.connectRequest(this.connection, {
             method: 'DELETE',
             url: this.publishersUrl + encodeURIComponent(assetId) + '/' + this.endpointName + '/' + encodeURIComponent(id)
         });
     }
-    throwError(response) {
-        // For Gacks, the error message is on response.body[0].message but for handled errors
-        // the error message is on response.body.Errors[0].description.
-        const errMessage = _.get(response, 'Errors[0].description') || _.get(response, '[0].message') || 'Unknown Error';
-        throw new core_1.SfdxError(errMessage);
-    }
 }
 exports.default = Publisher;
 //# sourceMappingURL=publisher.js.map

package/lib/lib/analytics/publisher/publisher.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"publisher.js","sourceRoot":"","sources":["../../../../src/lib/analytics/publisher/publisher.ts"],"names":[],"mappings":";;AAOA,wCAA4C;AAC5C,oCAAsC;AAQtC,MAAqB,SAAS;IAK5B,YAAmB,YAAiB;QAClC,IAAI,CAAC,UAAU,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAC/C,IAAI,CAAC,aAAa,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,mBAAmB,CAAC;QACrE,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,WAAmB;QACrC,MAAM,QAAQ,GAAG,MAAM,wBAAc,CAAgB,IAAI,CAAC,UAAU,EAAE;YACpE,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,IAAI,CAAC,aAAa,GAAG,kBAAkB,CAAC,WAAW,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,YAAY;YACnF,IAAI,EAAE,IAAI;SACX,CAAC,CAAC;QACH,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC,EAAE,CAAC;SACpB;aAAM;YACL,kBAAU,CAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,OAAe;QAC/B,MAAM,QAAQ,GAAG,MAAM,wBAAc,CAAmC,IAAI,CAAC,UAAU,EAAE;YACvF,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,IAAI,CAAC,aAAa,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,YAAY;SAChF,CAAC,CAAC;QACH,IAAI,QAAQ,EAAE;YACZ,OAAO,QAAQ,CAAC,UAAU,CAAC;SAC5B;aAAM;YACL,kBAAU,CAAC,QAAQ,CAAC,CAAC;SACtB;IACH,CAAC;IAEM,SAAS,CAAC,OAAe;QAC9B,OAAO,wBAAc,CAAC,IAAI,CAAC,UAAU,EAAE;YACrC,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,IAAI,CAAC,aAAa,GAAG,OAAO,GAAG,GAAG,GAAG,IAAI,CAAC,YAAY;SAC5D,CAAC,CAAC;IACL,CAAC;IAEM,MAAM,CAAC,OAAe,EAAE,EAAU;QACvC,OAAO,wBAAc,CAAC,IAAI,CAAC,UAAU,EAAE;YACrC,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,IAAI,CAAC,aAAa,GAAG,kBAAkB,CAAC,OAAO,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,YAAY,GAAG,GAAG,GAAG,kBAAkB,CAAC,EAAE,CAAC;SAC/G,CAAC,CAAC;IACL,CAAC;CACF;AAjDD,4BAiDC"}

package/lib/lib/analytics/query/query.d.ts

@@ -0,0 +1,165 @@
+import { flags, UX } from '@salesforce/command';
+import { Connection } from '@salesforce/core';
+export declare const LIMIT_FLAG: flags.Discriminated<flags.Number>;
+export declare const RESULT_FORMAT_FLAG: flags.Discriminated<flags.Enum<string>>;
+export declare const DRYRUN_FLAG: flags.Discriminated<flags.Boolean<boolean>>;
+export declare type QueryLanguage = 'Saql' | 'Sql';
+export declare type QueryRequest = {
+    query: string;
+    queryLanguage?: QueryLanguage;
+    timezone?: string;
+};
+declare type ExtraProps = Record<string, unknown>;
+export declare type QueryResults = ExtraProps & {
+    metadata: SaqlMetadata[] | SqlMetadata[] | SqlLiveMetadata;
+    records: Row[];
+};
+export declare type QueryResponse = QueryResults | (ExtraProps & {
+    query: string;
+    responseId: string;
+    responseTime: number;
+    action: string;
+    results: QueryResults;
+});
+export declare type SaqlMetadata = ExtraProps & {
+    lineage: SaqlLineageNode;
+    queryLanguage?: 'SAQL' | string;
+};
+export declare type SaqlLineageNode = SaqlGroupNode | SaqlForeachNode | SaqlUnionNode;
+export declare type SaqlGroup = ExtraProps & {
+    id: string;
+    datePart?: string;
+};
+export declare type SaqlGroupNode = ExtraProps & {
+    type: 'group';
+    groups: SaqlGroup[];
+};
+export declare type SaqlInput = ExtraProps & {
+    id: string;
+    function?: string;
+};
+declare type SaqlField = ExtraProps & {
+    id: string;
+    type?: 'string' | 'numeric' | 'boolean' | 'date' | 'dateonly' | 'datetime' | 'unknown';
+};
+declare type SaqlProjection = ExtraProps & {
+    field: SaqlField;
+    inputs?: SaqlInput[];
+};
+export declare type SaqlForeachNode = ExtraProps & {
+    type: 'foreach';
+    projections: SaqlProjection[];
+    input?: SaqlLineageNode;
+};
+export declare type SaqlUnionNode = ExtraProps & {
+    type: 'union';
+    inputs: Array<SaqlForeachNode | SaqlUnionNode>;
+};
+export declare type SqlMetadata = ExtraProps & {
+    columns: Array<ExtraProps & {
+        columnLabel: string;
+        columnType: string;
+    }>;
+    queryLanguage?: 'SQL' | string;
+};
+export declare type SqlLiveMetadata = ExtraProps & {
+    columns: Array<ExtraProps & {
+        label: string;
+        type: string;
+    }>;
+    queryLanguage?: 'SQL' | string;
+};
+declare type SingleValue = number | string | boolean | null;
+export declare type Row = {
+    [key: string]: SingleValue | SingleValue[];
+};
+/** A query request to an external data connector (e.g. Live Dataset). */
+export declare type ExternalQueryRequest = {
+    query: string;
+    connectorIdOrApiName: string;
+};
+export default class QuerySvc {
+    private readonly connection;
+    private readonly queryUrl;
+    constructor(connection: Connection);
+    execute(query: QueryRequest): Promise<QueryResponse>;
+    /** Make a query against an external data connector (i.e. Live Dataset). */
+    executeExternal(query: ExternalQueryRequest): Promise<QueryResponse>;
+    /** Convert any datanames names in the SAQL query to the dataset id/currentVersionId format, using
+     * a {@link DatasetSvc} to fetch the datasets.
+     */
+    mapDatasetNames(query: string): Promise<string>;
+    computeColumnNames(response: QueryResponse): string[];
+    /** Run a query-ish sfdx command and possibly do some output
+     *
+     * @param query the query request
+     * @param ux the command UX, or undefined to do no output
+     * @param limit the max number of rows to output and return (undefined for all)
+     * @param resultforamt 'json', 'csv', or anything else for an sfdx table
+     * @return the query response
+     */
+    runQueryCommand(query: QueryRequest, params: {
+        ux?: UX;
+        limit?: number;
+        resultformat?: string;
+        dryrun?: false;
+    }): Promise<QueryResponse>;
+    runQueryCommand(query: QueryRequest, params: {
+        ux?: UX;
+        limit?: number;
+        resultformat?: string;
+        dryrun: true;
+    }): Promise<undefined>;
+    runQueryCommand(query: QueryRequest, { ux, limit, resultformat, dryrun }: {
+        ux?: UX;
+        limit?: number;
+        resultformat?: string;
+        dryrun: boolean;
+    }): Promise<QueryResponse | undefined>;
+    /** Run an external query-ish sfdx command and possibly do some output
+     *
+     * @param query the query request
+     * @param ux the command UX, or undefined to do no output
+     * @param limit the max number of rows to output and return (undefined for all)
+     * @param resultforamt 'json', 'csv', or anything else for an sfdx table
+     * @return the query response
+     */
+    runExternalQueryCommand(query: ExternalQueryRequest, params: {
+        ux?: UX;
+        limit?: number;
+        resultformat?: string;
+        dryrun?: false;
+    }): Promise<QueryResponse>;
+    runExternalQueryCommand(query: ExternalQueryRequest, params: {
+        ux?: UX;
+        limit?: number;
+        resultformat?: string;
+        dryrun: true;
+    }): Promise<undefined>;
+    runExternalQueryCommand(query: ExternalQueryRequest, { ux, limit, resultformat, dryrun }: {
+        ux?: UX;
+        limit?: number;
+        resultformat?: string;
+        dryrun: boolean;
+    }): Promise<QueryResponse | undefined>;
+    /** Process a query response, possibly doing some output.
+     *
+     * @param query the query request
+     * @param ux the command UX, or undefined to do no output
+     * @param limit the max number of rows to output and return (undefined for all)
+     * @param resultforamt 'json', 'csv', or anything else for an sfdx table
+     * @return the query response
+     */
+    private processQueryCommandResponse;
+}
+export declare function convertRowValue(value: unknown): string;
+/** Convert any datanames names in the SAQL query to the dataset id/currentVersionId format.
+ *
+ * @param query the saql text.
+ * @param nameToRef function to map dataset name to "id/versionId" ref format, should throw an error if
+ *                  the dataset is unavailable.
+ */
+export declare function mapDatasetNames(query: string, nameToRef: (name: string) => Promise<string>): Promise<string>;
+/** Compute the set of columns names from the query response metadata. */
+export declare function computeColumnNames(response: QueryResponse): string[];
+export {};

package/lib/lib/analytics/query/query.js

@@ -0,0 +1,258 @@
+"use strict";
+/*
+ * Copyright (c) 2021, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.computeColumnNames = exports.mapDatasetNames = exports.convertRowValue = exports.DRYRUN_FLAG = exports.RESULT_FORMAT_FLAG = exports.LIMIT_FLAG = void 0;
+const command_1 = require("@salesforce/command");
+const core_1 = require("@salesforce/core");
+const dataset_1 = __importDefault(require("../dataset/dataset"));
+const request_1 = require("../request");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/analytics', 'query');
+exports.LIMIT_FLAG = command_1.flags.number({
+    description: messages.getMessage('limitDescription'),
+    longDescription: messages.getMessage('limitLongDescription'),
+    min: 0
+});
+exports.RESULT_FORMAT_FLAG = command_1.flags.enum({
+    char: 'r',
+    description: messages.getMessage('resultformatDescription'),
+    longDescription: messages.getMessage('resultformatLongDescription'),
+    options: ['human', 'csv', 'json'],
+    default: 'human'
+});
+exports.DRYRUN_FLAG = command_1.flags.boolean({
+    hidden: true,
+    description: "Show the resulting query that would be executed, but don't run it",
+    default: false
+});
+class QuerySvc {
+    constructor(connection) {
+        this.connection = connection;
+        this.queryUrl = `${this.connection.baseUrl()}/wave/query`;
+    }
+    async execute(query) {
+        const response = await request_1.connectRequest(this.connection, {
+            method: 'POST',
+            url: this.queryUrl,
+            body: JSON.stringify(query)
+        });
+        if (response) {
+            return response;
+        }
+        else {
+            throw new core_1.SfdxError('Empty http response');
+        }
+    }
+    /** Make a query against an external data connector (i.e. Live Dataset). */
+    async executeExternal(query) {
+        const response = await request_1.connectRequest(this.connection, {
+            method: 'POST',
+            url: `${this.connection.baseUrl()}/wave/dataConnectors/${encodeURIComponent(query.connectorIdOrApiName)}/query`,
+            body: JSON.stringify({ query: query.query })
+        });
+        if (response) {
+            return response;
+        }
+        else {
+            throw new core_1.SfdxError('Empty http response');
+        }
+    }
+    /** Convert any datanames names in the SAQL query to the dataset id/currentVersionId format, using
+     * a {@link DatasetSvc} to fetch the datasets.
+     */
+    async mapDatasetNames(query) {
+        const dsSvc = new dataset_1.default(this.connection);
+        return mapDatasetNames(query, async (name) => {
+            let dataset;
+            try {
+                dataset = await dsSvc.fetch(name);
+            }
+            catch (error) {
+                const msg = error instanceof Error ? error.message : String(error);
+                throw new core_1.SfdxError(`Unable to fetch dataset ${name}: ${msg}`);
+            }
+            if (!dataset.currentVersionId) {
+                throw new core_1.SfdxError(`Dataset ${name} (${dataset.id}) does not have a current version id`);
+            }
+            return `${dataset.id}/${dataset.currentVersionId}`;
+        });
+    }
+    computeColumnNames(response) {
+        return computeColumnNames(response);
+    }
+    async runQueryCommand(query, { ux, limit, resultformat, dryrun = false }) {
+        if (dryrun) {
+            ux === null || ux === void 0 ? void 0 : ux.log(messages.getMessage('dryrunHeader'));
+            ux === null || ux === void 0 ? void 0 : ux.logJson(query);
+            return undefined;
+        }
+        return this.processQueryCommandResponse(await this.execute(query), { ux, limit, resultformat });
+    }
+    async runExternalQueryCommand(query, { ux, limit, resultformat, dryrun = false }) {
+        if (dryrun) {
+            ux === null || ux === void 0 ? void 0 : ux.log(messages.getMessage('dryrunHeader'));
+            ux === null || ux === void 0 ? void 0 : ux.log(query.query);
+            return undefined;
+        }
+        return this.processQueryCommandResponse(await this.executeExternal(query), { ux, limit, resultformat });
+    }
+    /** Process a query response, possibly doing some output.
+     *
+     * @param query the query request
+     * @param ux the command UX, or undefined to do no output
+     * @param limit the max number of rows to output and return (undefined for all)
+     * @param resultforamt 'json', 'csv', or anything else for an sfdx table
+     * @return the query response
+     */
+    processQueryCommandResponse(response, { ux, limit, resultformat }) {
+        const results = getQueryResults(response);
+        const records = results && Array.isArray(results === null || results === void 0 ? void 0 : results.records) ? results.records : [];
+        if (typeof limit === 'number' && limit >= 0 && records.length > limit) {
+            records.length = limit;
+        }
+        if (ux) {
+            if (resultformat === 'json') {
+                ux.logJson(response);
+            }
+            else {
+                const columnNames = this.computeColumnNames(response);
+                if (resultformat === 'csv') {
+                    writeCsvLine(ux, columnNames);
+                    records.forEach(record => {
+                        const values = columnNames.map(columnName => record[columnName]);
+                        writeCsvLine(ux, values);
+                    });
+                }
+                else {
+                    // resultformat === 'human', do a table
+                    if (columnNames.length <= 0) {
+                        ux.log(messages.getMessage('noResultsMesg'));
+                    }
+                    else {
+                        ux.table(records, {
+                            columns: columnNames.map(name => {
+                                return {
+                                    key: name,
+                                    label: name,
+                                    format: convertRowValue
+                                };
+                            })
+                        });
+                        ux.styledHeader(messages.getMessage('rowsFound', [records.length]));
+                    }
+                }
+            }
+        }
+        return response;
+    }
+}
+exports.default = QuerySvc;
+function convertRowValue(value) {
+    return Array.isArray(value) ? '[' + value.join(',') + ']' : typeof value === 'string' ? value : String(value);
+}
+exports.convertRowValue = convertRowValue;
+function writeCsvLine(ux, values, delim = ',') {
+    let line = '';
+    for (let i = 0; i < values.length; i++) {
+        if (i !== 0) {
+            line += delim;
+        }
+        if (values[i]) {
+            const value = convertRowValue(values[i]).replace(/"/g, '""');
+            if (value.indexOf(delim) >= 0 || value.indexOf('\n') >= 0) {
+                line += `"${value}"`;
+            }
+            else {
+                line += value;
+            }
+        }
+    }
+    ux.log(line);
+}
+const LOAD_RE = /load(\s+)"([^"]+)"/;
+/** Convert any datanames names in the SAQL query to the dataset id/currentVersionId format.
+ *
+ * @param query the saql text.
+ * @param nameToRef function to map dataset name to "id/versionId" ref format, should throw an error if
+ *                  the dataset is unavailable.
+ */
+async function mapDatasetNames(query, nameToRef) {
+    // go through each expression in the saql
+    const lines = query.split(';');
+    for (let i = 0, len = lines.length; i < len; i++) {
+        // see if it's a '... load "DatasetName"'
+        const matches = LOAD_RE.exec(lines[i]);
+        if (!matches || !matches[2]) {
+            continue;
+        }
+        // pull the dataset name from that
+        const name = matches[2];
+        // if it's not already of the "id/versionid" form, fetch the dataset and string sub
+        if (name.indexOf('/') < 0) {
+            const ref = await nameToRef(name);
+            lines[i] = lines[i].replace(matches[0], `load${matches[1]}"${ref}"`);
+        }
+    }
+    return lines.join(';');
+}
+exports.mapDatasetNames = mapDatasetNames;
+function getQueryResults(response) {
+    return typeof response.metadata === 'object' || typeof response.records === 'object'
+        ? response
+        : response.results;
+}
+/** Compute the set of columns names from the query response metadata. */
+function computeColumnNames(response) {
+    const names = new Set();
+    const results = getQueryResults(response);
+    if (results && Array.isArray(results === null || results === void 0 ? void 0 : results.metadata)) {
+        results.metadata.forEach((md) => {
+            var _a;
+            // SqlMetadata
+            if (Array.isArray(md === null || md === void 0 ? void 0 : md.columns)) {
+                md.columns.forEach((c) => {
+                    if (c.columnLabel) {
+                        names.add(c.columnLabel);
+                    }
+                });
+            }
+            else if (Array.isArray((_a = md === null || md === void 0 ? void 0 : md.lineage) === null || _a === void 0 ? void 0 : _a.projections)) {
+                // SaqlMetadata
+                md.lineage.projections.forEach((p) => {
+                    var _a;
+                    if ((_a = p.field) === null || _a === void 0 ? void 0 : _a.id) {
+                        let name = p.field.id;
+                        const index = name.indexOf('.');
+                        if (index >= 0) {
+                            name = name.substring(index + 1);
+                        }
+                        names.add(name);
+                    }
+                });
+            }
+        });
+    }
+    else if (typeof (results === null || results === void 0 ? void 0 : results.metadata) === 'object' && Array.isArray(results.metadata.columns)) {
+        // SqlLiveMetadata
+        results.metadata.columns.forEach((col) => {
+            if (col.label) {
+                names.add(col.label);
+            }
+        });
+    }
+    // if the metadata didn't match anything, just use the keys in the first result record
+    if (names.size <= 0 && results && Array.isArray(results.records) && results.records[0]) {
+        return Object.keys(results.records[0]);
+    }
+    return Array.from(names);
+}
+exports.computeColumnNames = computeColumnNames;
+//# sourceMappingURL=query.js.map