@heroku/heroku-cli-util 10.8.2 → 10.9.0

package/dist/utils/index.d.ts

@@ -2,6 +2,7 @@ export { AmbiguousError } from '../errors/ambiguous.js';
 export { NotFound } from '../errors/not-found.js';
 export { default as AddonResolver } from './addons/addon-resolver.js';
 export { getAddonService, isAdvancedDatabase, isAdvancedPrivateDatabase, isEssentialDatabase, isLegacyDatabase, isLegacyEssentialDatabase, isPostgresAddon, } from './addons/helpers.js';
+export { default as parseKeyValue } from './parse-key-value.js';
 export { getPsqlConfigs, sshTunnel } from './pg/bastion.js';
 export { getConfigVarNameFromAttachment } from './pg/config-vars.js';
 export { default as DatabaseResolver } from './pg/databases.js';

package/dist/utils/index.js

@@ -2,6 +2,7 @@ export { AmbiguousError } from '../errors/ambiguous.js';
 export { NotFound } from '../errors/not-found.js';
 export { default as AddonResolver } from './addons/addon-resolver.js';
 export { getAddonService, isAdvancedDatabase, isAdvancedPrivateDatabase, isEssentialDatabase, isLegacyDatabase, isLegacyEssentialDatabase, isPostgresAddon, } from './addons/helpers.js';
+export { default as parseKeyValue } from './parse-key-value.js';
 export { getPsqlConfigs, sshTunnel } from './pg/bastion.js';
 export { getConfigVarNameFromAttachment } from './pg/config-vars.js';
 export { default as DatabaseResolver } from './pg/databases.js';

package/dist/utils/parse-key-value.d.ts

@@ -0,0 +1,4 @@
+export default function parseKeyValue(input: string): {
+    key: string;
+    value: string;
+};

package/dist/utils/parse-key-value.js

@@ -0,0 +1,6 @@
+export default function parseKeyValue(input) {
+    let [key, value] = input.split(/=(.*)/);
+    key = key.trim();
+    value = value ? value.trim() : '';
+    return { key, value };
+}

package/dist/ux/table.d.ts

@@ -8,7 +8,14 @@ type Column<T extends Record<string, unknown>> = {
 type Columns<T extends Record<string, unknown>> = {
     [key: string]: Partial<Column<T>>;
 };
-export declare function table<T extends Record<string, unknown>>(data: T[], columns: Columns<T>, options?: Omit<TableOptions<T>, 'columns' | 'data'> & {
+type TableFlags = {
+    columns?: string;
+    csv?: boolean;
+    extended?: boolean;
+    filter?: string;
+    sort?: string;
+};
+export declare function table<T extends Record<string, unknown>>(data: T[], columns: Columns<T>, options?: Omit<TableOptions<T>, 'columns' | 'data' | 'filter' | 'sort'> & TableFlags & {
     printLine?(s: unknown): void;
 }): void;
 export {};

package/dist/ux/table.js

@@ -1,26 +1,147 @@
+import { ux } from '@oclif/core/ux';
 import { printTable } from '@oclif/table';
-export function table(data, columns, options) {
-    const cols = Object.entries(columns).map(([key, opts]) => {
-        if (opts.header)
-            return { key, name: opts.header };
+import { orderBy } from 'natural-orderby';
+import parseKeyValue from '../utils/parse-key-value.js';
+/**
+ * Finds a column by id (header name or property key), case-insensitively.
+ * Returns undefined if no match found.
+ */
+function getColumnById(id, columns) {
+    const lowerCaseId = id.toLowerCase();
+    for (const [key, col] of Object.entries(columns)) {
+        if (col.header?.toLowerCase() === lowerCaseId || key.toLowerCase() === lowerCaseId) {
+            return [key, col];
+        }
+    }
+    return undefined;
+}
+/**
+ * Selects columns based on --columns or --extended flags.
+ * --columns takes precedence over --extended.
+ */
+function selectColumns(columns, flags) {
+    if (flags.columns) {
+        const columnIds = flags.columns.split(',').filter(id => id.trim());
+        const uniqueColumnIds = [...new Set(columnIds)];
+        const selectedColumns = {};
+        for (const id of uniqueColumnIds) {
+            const column = getColumnById(id, columns);
+            if (!column) {
+                throw new Error('Columns flag has an invalid value.');
+            }
+            const [key, col] = column;
+            selectedColumns[key] = col;
+        }
+        return selectedColumns;
+    }
+    if (!flags.extended) {
+        const baseColumns = {};
+        for (const [key, col] of Object.entries(columns)) {
+            if (!col.extended) {
+                baseColumns[key] = col;
+            }
+        }
+        return baseColumns;
+    }
+    return columns;
+}
+/**
+ * Builds a filter predicate function for substring matching.
+ */
+function getFilterPredicate(columns, filter) {
+    const { key: columnId, value: searchValue } = parseKeyValue(filter);
+    if (!searchValue) {
+        throw new Error('Filter flag has an invalid value.');
+    }
+    const column = getColumnById(columnId, columns);
+    if (!column) {
+        throw new Error('Filter flag has an invalid value.');
+    }
+    const [key] = column;
+    return (row) => {
+        const cellValue = String(row[key] ?? '');
+        return cellValue.includes(searchValue);
+    };
+}
+/**
+ * Gets the identifiers for the sort properties.
+ */
+function getSortIds(columns, sort) {
+    const sortIds = sort
+        .split(',')
+        .filter(id => id.trim())
+        .map(id => {
+        const column = getColumnById(id, columns);
+        if (!column) {
+            throw new Error('Sort flag has an invalid value.');
+        }
+        const [key] = column;
         return key;
     });
-    const d = data.map(row => Object.fromEntries(Object.entries(columns).map(([key, { get }]) => [key, get ? get(row) : row[key]])));
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    const { printLine, ...tableOptions } = options || {};
-    printTable({
-        ...(tableOptions?.noStyle
-            ? {}
-            : {
-                borderColor: 'whiteBright',
-                borderStyle: 'headers-only-with-underline',
-                headerOptions: {
-                    bold: true,
-                    color: 'white', // or 'reset' to use default terminal color
-                },
-            }),
-        ...tableOptions,
-        columns: cols,
-        data: d,
+    if (sortIds.length === 0) {
+        throw new Error('Sort flag has an invalid value.');
+    }
+    return sortIds;
+}
+function escapeCSV(value) {
+    const needsEscaping = /["\n\r,]/.test(value);
+    return needsEscaping ? `"${value.replaceAll('"', '""')}"` : value;
+}
+function outputCSV(data, columns, printLine) {
+    const columnEntries = Object.entries(columns);
+    const columnHeaders = columnEntries.map(([key, col]) => col.header || key);
+    printLine(columnHeaders.join(','));
+    for (const row of data) {
+        const values = columnEntries.map(([key]) => {
+            const value = row[key];
+            return escapeCSV(String(value ?? ''));
+        });
+        printLine(values.join(','));
+    }
+}
+export function table(data, columns, options) {
+    const selectedColumns = selectColumns(columns, {
+        columns: options?.columns,
+        extended: options?.extended,
     });
+    let processedData = data.map(row => Object.fromEntries(Object.entries(selectedColumns).map(([key, { get }]) => [
+        key,
+        get ? get(row) : row[key],
+    ])));
+    if (options?.filter) {
+        const filterPredicate = getFilterPredicate(selectedColumns, options.filter);
+        processedData = processedData.filter(row => filterPredicate(row));
+    }
+    if (options?.sort) {
+        const sortIds = getSortIds(selectedColumns, options.sort);
+        processedData = orderBy(processedData, sortIds, ['asc']);
+    }
+    if (options?.csv) {
+        const printFn = options?.printLine || ux.stdout;
+        outputCSV(processedData, selectedColumns, printFn);
+    }
+    else {
+        const cols = Object.entries(selectedColumns).map(([key, opts]) => {
+            if (opts.header)
+                return { key, name: opts.header };
+            return key;
+        });
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { columns, csv, extended, filter, printLine, sort, ...tableOptions } = options || {};
+        printTable({
+            ...(tableOptions?.noStyle
+                ? {}
+                : {
+                    borderColor: 'whiteBright',
+                    borderStyle: 'headers-only-with-underline',
+                    headerOptions: {
+                        bold: true,
+                        color: 'white', // or 'reset' to use default terminal color
+                    },
+                }),
+            ...tableOptions,
+            columns: cols,
+            data: processedData,
+        });
+    }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@heroku/heroku-cli-util",
-  "version": "10.8.2",
+  "version": "10.9.0",
   "description": "Set of helpful CLI utilities",
   "author": "Heroku",
   "license": "ISC",
@@ -70,13 +70,14 @@
     "vitest": "^4.1.6"
   },
   "dependencies": {
-    "@heroku-cli/command": "^12.4.0",
+    "@heroku-cli/command": "^12.4.2",
     "@heroku/http-call": "^5.5.0",
     "@oclif/core": "^4.3.0",
     "@oclif/table": "0.5.9",
     "ansis": "^4.1.0",
     "debug": "^4.4.0",
     "inquirer": "^12.6.1",
+    "natural-orderby": "^5.0.0",
     "open": "^11",
     "printf": "^0.6.1",
     "tsheredoc": "^1.0.1",