@salesforce/apex-node 3.1.0 → 4.0.2

package/lib/src/utils/tableWritableStream.js

@@ -0,0 +1,111 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TableWriteableStream = void 0;
+const elapsedTime_1 = require("./elapsedTime");
+const core_1 = require("@salesforce/core");
+const COLUMN_SEPARATOR = '  ';
+const COLUMN_FILLER = ' ';
+const HEADER_FILLER = '─';
+class TableWriteableStream {
+    stream;
+    constructor(stream) {
+        this.stream = stream;
+        this.stream = stream;
+    }
+    createTable(rows, cols, title) {
+        if (!rows) {
+            throw Error('rows cannot be undefined');
+        }
+        if (!cols) {
+            throw Error('columns cannot be undefined');
+        }
+        const maxColWidths = this.calculateMaxColumnWidths(rows, cols);
+        let columnHeader = '';
+        let headerSeparator = '';
+        cols.forEach((col, index, arr) => {
+            const width = maxColWidths.get(col.key);
+            if (width) {
+                const isLastCol = index === arr.length - 1;
+                columnHeader += this.fillColumn(col.label || col.key, width, COLUMN_FILLER, isLastCol);
+                headerSeparator += this.fillColumn('', width, HEADER_FILLER, isLastCol);
+            }
+        });
+        if (columnHeader && headerSeparator) {
+            this.stream.push(`${title ? `=== ${title}\n` : ''}${columnHeader}\n${headerSeparator}\n`);
+        }
+        rows.forEach((row) => {
+            let outputRow = '';
+            cols.forEach((col, colIndex, colArr) => {
+                const cell = row[col.key];
+                const isLastCol = colIndex === colArr.length - 1;
+                const rowWidth = outputRow.length;
+                cell.split('\n').forEach((line, lineIndex) => {
+                    const cellWidth = maxColWidths.get(col.key);
+                    if (cellWidth) {
+                        if (lineIndex === 0) {
+                            outputRow += this.fillColumn(line, cellWidth, COLUMN_FILLER, isLastCol);
+                        }
+                        else {
+                            outputRow +=
+                                '\n' +
+                                    this.fillColumn('', rowWidth, COLUMN_FILLER, true) +
+                                    this.fillColumn(line, cellWidth, COLUMN_FILLER, isLastCol);
+                        }
+                    }
+                });
+            });
+            this.stream.push(outputRow + '\n');
+        });
+    }
+    calculateMaxColumnWidths(rows, cols) {
+        const maxColWidths = new Map();
+        cols.forEach((col) => {
+            rows.forEach((row) => {
+                const cell = row[col.key];
+                if (cell === undefined) {
+                    throw Error(`Row is missing the key ${col.key}`);
+                }
+                let maxColWidth = maxColWidths.get(col.key);
+                if (maxColWidth === undefined) {
+                    maxColWidth = (col.label || col.key).length;
+                    maxColWidths.set(col.key, maxColWidth);
+                }
+                // if a cell is multiline, find the line that's the longest
+                const longestLineWidth = cell
+                    .split('\n')
+                    .reduce((maxLine, line) => line.length > maxLine.length ? line : maxLine).length;
+                if (longestLineWidth > maxColWidth) {
+                    maxColWidths.set(col.key, longestLineWidth);
+                }
+            });
+        });
+        return maxColWidths;
+    }
+    fillColumn(label, width, filler, isLastCol) {
+        let filled = label;
+        for (let i = 0; i < width - label.length; i++) {
+            filled += filler;
+        }
+        if (!isLastCol) {
+            filled += COLUMN_SEPARATOR;
+        }
+        return filled;
+    }
+}
+exports.TableWriteableStream = TableWriteableStream;
+__decorate([
+    (0, elapsedTime_1.elapsedTime)()
+], TableWriteableStream.prototype, "createTable", null);
+__decorate([
+    (0, elapsedTime_1.elapsedTime)()
+], TableWriteableStream.prototype, "calculateMaxColumnWidths", null);
+__decorate([
+    (0, elapsedTime_1.elapsedTime)('elapsedTime', core_1.LoggerLevel.TRACE)
+], TableWriteableStream.prototype, "fillColumn", null);
+//# sourceMappingURL=tableWritableStream.js.map

package/lib/src/utils/tableWritableStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tableWritableStream.js","sourceRoot":"","sources":["../../../src/utils/tableWritableStream.ts"],"names":[],"mappings":";;;;;;;;;AAOA,+CAA4C;AAC5C,2CAA+C;AAC/C,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,aAAa,GAAG,GAAG,CAAC;AAC1B,MAAM,aAAa,GAAG,GAAG,CAAC;AAW1B,MAAa,oBAAoB;IACF;IAA7B,YAA6B,MAAgB;QAAhB,WAAM,GAAN,MAAM,CAAU;QAC3C,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAGM,WAAW,CAAC,IAAW,EAAE,IAAc,EAAE,KAAc;QAC5D,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAC1C,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,KAAK,CAAC,6BAA6B,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAE/D,IAAI,YAAY,GAAG,EAAE,CAAC;QACtB,IAAI,eAAe,GAAG,EAAE,CAAC;QACzB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YAC/B,MAAM,KAAK,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,SAAS,GAAG,KAAK,KAAK,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC3C,YAAY,IAAI,IAAI,CAAC,UAAU,CAC7B,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,GAAG,EACpB,KAAK,EACL,aAAa,EACb,SAAS,CACV,CAAC;gBACF,eAAe,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,YAAY,IAAI,eAAe,EAAE,CAAC;YACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,GAAG,KAAK,CAAC,CAAC,CAAC,OAAO,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,YAAY,KAAK,eAAe,IAAI,CACxE,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,SAAS,GAAG,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE;gBACrC,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC1B,MAAM,SAAS,GAAG,QAAQ,KAAK,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;gBACjD,MAAM,QAAQ,GAAG,SAAS,CAAC,MAAM,CAAC;gBAClC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE;oBAC3C,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBAC5C,IAAI,SAAS,EAAE,CAAC;wBACd,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;4BACpB,SAAS,IAAI,IAAI,CAAC,UAAU,CAC1B,IAAI,EACJ,SAAS,EACT,aAAa,EACb,SAAS,CACV,CAAC;wBACJ,CAAC;6BAAM,CAAC;4BACN,SAAS;gCACP,IAAI;oCACJ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,QAAQ,EAAE,aAAa,EAAE,IAAI,CAAC;oCAClD,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;wBAC/D,CAAC;oBACH,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;IACL,CAAC;IAGO,wBAAwB,CAC9B,IAAW,EACX,IAAc;QAEd,MAAM,YAAY,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC/C,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACnB,MAAM,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC1B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;oBACvB,MAAM,KAAK,CAAC,0BAA0B,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC;gBACnD,CAAC;gBAED,IAAI,WAAW,GAAG,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC5C,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;oBAC9B,WAAW,GAAG,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;oBAC5C,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;gBACzC,CAAC;gBAED,2DAA2D;gBAC3D,MAAM,gBAAgB,GAAG,IAAI;qBAC1B,KAAK,CAAC,IAAI,CAAC;qBACX,MAAM,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,CACxB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAC9C,CAAC,MAAM,CAAC;gBACX,IAAI,gBAAgB,GAAG,WAAW,EAAE,CAAC;oBACnC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;gBAC9C,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,OAAO,YAAY,CAAC;IACtB,CAAC;IAGO,UAAU,CAChB,KAAa,EACb,KAAa,EACb,MAAc,EACd,SAAkB;QAElB,IAAI,MAAM,GAAG,KAAK,CAAC;QACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9C,MAAM,IAAI,MAAM,CAAC;QACnB,CAAC;QACD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,gBAAgB,CAAC;QAC7B,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAnHD,oDAmHC;AA7GQ;IADN,IAAA,yBAAW,GAAE;uDA2Db;AAGO;IADP,IAAA,yBAAW,GAAE;oEA+Bb;AAGO;IADP,IAAA,yBAAW,EAAC,aAAa,EAAE,kBAAW,CAAC,KAAK,CAAC;sDAe7C"}

package/lib/src/utils/types.d.ts

@@ -51,4 +51,17 @@ export type DataRecordResult = {
 export type IdRecord = {
     Id: string;
 };
+export interface Row {
+    [column: string]: string;
+}
+export interface Column {
+    key: string;
+    label: string;
+}
+export interface Title {
+    title: string;
+}
+export type TableConfig = Title & {
+    columns: Column[];
+};
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/apex-node",
   "description": "Salesforce JS library for Apex",
-  "version": "3.1.0",
+  "version": "4.0.2",
   "author": "Salesforce",
   "bugs": "https://github.com/forcedotcom/salesforcedx-apex/issues",
   "main": "lib/src/index.js",