@oclif/table 0.1.0 → 0.1.2

package/lib/index.d.ts

@@ -1,2 +1,2 @@
-export { makeTable, makeTables } from './table.js';
-export type { TableProps } from './types.js';
+export { printTable, printTables } from './table.js';
+export type { TableOptions } from './types.js';

package/lib/index.js

@@ -1 +1 @@
-export { makeTable, makeTables } from './table.js';
+export { printTable, printTables } from './table.js';

package/lib/table.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
-import { CellProps, ContainerProps, ScalarDict, TableProps } from './types.js';
-export declare function Table<T extends ScalarDict>(props: TableProps<T>): React.JSX.Element;
+import { CellProps, ContainerProps, TableOptions } from './types.js';
+export declare function Table<T extends Record<string, unknown>>(props: TableOptions<T>): React.JSX.Element;
 /**
  * Renders the header of a table.
  */
@@ -17,9 +17,9 @@ export declare function Skeleton(props: React.PropsWithChildren & {
 }): React.JSX.Element;
 /**
  * Renders a table with the given data.
- * @param options see {@link TableProps}
+ * @param options see {@link TableOptions}
  */
-export declare function makeTable<T extends ScalarDict>(options: TableProps<T>): void;
-export declare function makeTables<T extends ScalarDict[]>(tables: {
-    [P in keyof T]: TableProps<T[P]>;
+export declare function printTable<T extends Record<string, unknown>>(options: TableOptions<T>): void;
+export declare function printTables<T extends Record<string, unknown>[]>(tables: {
+    [P in keyof T]: TableOptions<T[P]>;
 }, options?: Omit<ContainerProps, 'children'>): void;

package/lib/table.js

@@ -215,16 +215,16 @@ export function Skeleton(props) {
 }
 /**
  * Renders a table with the given data.
- * @param options see {@link TableProps}
+ * @param options see {@link TableOptions}
  */
-export function makeTable(options) {
+export function printTable(options) {
     const instance = render(React.createElement(Table, { ...options }));
     instance.unmount();
 }
 function Container(props) {
     return (React.createElement(Box, { flexWrap: "wrap", flexDirection: props.direction ?? 'row', ...props }, props.children));
 }
-export function makeTables(tables, options) {
+export function printTables(tables, options) {
     const leftMargin = options?.marginLeft ?? options?.margin ?? 0;
     const rightMargin = options?.marginRight ?? options?.margin ?? 0;
     const columns = process.stdout.columns - (leftMargin + rightMargin);

package/lib/types.d.ts

@@ -1,8 +1,4 @@
 import { BorderStyle } from './skeletons.js';
-export type Scalar = string | number | boolean | null | undefined;
-export type ScalarDict = {
-    [key: string]: Scalar;
-};
 export type CellProps = React.PropsWithChildren<{
     readonly column: number;
 }>;
@@ -60,7 +56,7 @@ type SortOrder<T> = 'asc' | 'desc' | ((valueA: T, valueB: T) => number);
 export type Sort<T> = {
     [K in keyof T]?: SortOrder<T[K]>;
 };
-export type TableProps<T extends ScalarDict> = {
+export type TableOptions<T extends Record<string, unknown>> = {
     /**
      * List of values (rows).
      */
@@ -123,16 +119,16 @@ export type TableProps<T extends ScalarDict> = {
      * ]
      *
      * // sort the name column in ascending order
-     * makeTable({data, sort: {name: 'asc'}})
+     * printTable({data, sort: {name: 'asc'}})
      *
      * // sort the name column in descending order
-     * makeTable({data, sort: {name: 'desc'}})
+     * printTable({data, sort: {name: 'desc'}})
      *
      * // sort by name in ascending order and age in descending order
-     * makeTable({data, sort: {name: 'asc', age: 'desc'}})
+     * printTable({data, sort: {name: 'asc', age: 'desc'}})
      *
      * // sort by name in ascending order and age in descending order using a custom sort function
-     * makeTable({data, sort: {name: 'asc', age: (a, b) => b - a}})
+     * printTable({data, sort: {name: 'asc', age: (a, b) => b - a}})
      * ```
      */
     sort?: Sort<T>;
@@ -208,7 +204,7 @@ export type RowConfig = {
         color: SupportedColor | undefined;
     };
 };
-export type RowProps<T extends ScalarDict> = {
+export type RowProps<T extends Record<string, unknown>> = {
     readonly key: string;
     readonly data: Partial<T>;
     readonly columns: Column<T>[];

package/lib/utils.d.ts

@@ -1,4 +1,4 @@
-import { Column, Config, ScalarDict, Sort } from './types.js';
+import { Column, Config, Sort } from './types.js';
 /**
  * Intersperses a list of elements with another element.
  *
@@ -8,8 +8,8 @@ import { Column, Config, ScalarDict, Sort } from './types.js';
  * ```
  */
 export declare function intersperse<T, I>(intersperser: (index: number) => I, elements: T[]): (T | I)[];
-export declare function sortData<T extends ScalarDict>(data: T[], sort?: Sort<T> | undefined): T[];
-export declare function allKeysInCollection<T extends ScalarDict>(data: T[]): (keyof T)[];
-export declare function getColumns<T extends ScalarDict>(config: Config<T>, headings: Partial<T>): Column<T>[];
-export declare function getHeadings<T extends ScalarDict>(config: Config<T>): Partial<T>;
-export declare function maybeStripAnsi<T extends ScalarDict[]>(data: T, noStyle: boolean): T;
+export declare function sortData<T extends Record<string, unknown>>(data: T[], sort?: Sort<T> | undefined): T[];
+export declare function allKeysInCollection<T extends Record<string, unknown>>(data: T[]): (keyof T)[];
+export declare function getColumns<T extends Record<string, unknown>>(config: Config<T>, headings: Partial<T>): Column<T>[];
+export declare function getHeadings<T extends Record<string, unknown>>(config: Config<T>): Partial<T>;
+export declare function maybeStripAnsi<T extends Record<string, unknown>[]>(data: T, noStyle: boolean): T;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oclif/table",
   "description": "Display table in terminal",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/multi-stage-output/issues",
   "dependencies": {