@easypost/easy-ui 1.0.0-alpha.77 → 1.0.0-alpha.78

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @easypost/easy-ui
 
+## 1.0.0-alpha.78
+
+### Patch Changes
+
+- df594c1: Adds better types for the datagrid component
+
 ## 1.0.0-alpha.77
 
 ### Minor Changes

package/DataGrid/DataGrid.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-import { Column as ColumnType, DataGridProps } from "./types";
+import { Column as ColumnType, Row as RowType, DataGridProps } from "./types";
 /**
  * A `DataGrid` is an interactive table used for working with a large
  * collection of data in a scannable way.
@@ -35,5 +35,5 @@ import { Column as ColumnType, DataGridProps } from "./types";
  *   )}
  * />
  */
-export declare function DataGrid<C extends ColumnType = ColumnType>(props: DataGridProps<C>): React.JSX.Element;
+export declare function DataGrid<C extends ColumnType = ColumnType, R extends RowType = RowType>(props: DataGridProps<C, R>): React.JSX.Element;
 //# sourceMappingURL=DataGrid.d.ts.map

package/DataGrid/DataGrid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DataGrid.d.ts","sourceRoot":"","sources":["../../src/DataGrid/DataGrid.tsx"],"names":[],"mappings":"AACA,OAAO,KAAyC,MAAM,OAAO,CAAC;AAQ9D,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,UAAU,GAAG,UAAU,EACxD,KAAK,EAAE,aAAa,CAAC,CAAC,CAAC,qBAqHxB"}
+{"version":3,"file":"DataGrid.d.ts","sourceRoot":"","sources":["../../src/DataGrid/DataGrid.tsx"],"names":[],"mappings":"AACA,OAAO,KAAyC,MAAM,OAAO,CAAC;AAQ9D,OAAO,EAAE,MAAM,IAAI,UAAU,EAAE,GAAG,IAAI,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE9E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,wBAAgB,QAAQ,CACtB,CAAC,SAAS,UAAU,GAAG,UAAU,EACjC,CAAC,SAAS,OAAO,GAAG,OAAO,EAC3B,KAAK,EAAE,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,qBAoH3B"}

package/DataGrid/Table.d.ts

@@ -1,8 +1,8 @@
 import React, { ReactElement } from "react";
-import { Column, DataGridProps } from "./types";
-type TableProps<C extends Column> = Omit<DataGridProps<C>, "children"> & {
+import { Column, DataGridProps, Row as RowType } from "./types";
+type TableProps<C extends Column, R extends RowType> = Omit<DataGridProps<C, R>, "children"> & {
     children?: [ReactElement, ReactElement];
 };
-export declare function Table<C extends Column>(props: TableProps<C>): React.JSX.Element;
+export declare function Table<C extends Column, R extends RowType>(props: TableProps<C, R>): React.JSX.Element;
 export {};
 //# sourceMappingURL=Table.d.ts.map

package/DataGrid/Table.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Table.d.ts","sourceRoot":"","sources":["../../src/DataGrid/Table.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAiB,YAAY,EAAmB,MAAM,OAAO,CAAC;AAiB5E,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAOhD,KAAK,UAAU,CAAC,CAAC,SAAS,MAAM,IAAI,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,GAAG;IACvE,QAAQ,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;CACzC,CAAC;AAEF,wBAAgB,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,qBA6I3D"}
+{"version":3,"file":"Table.d.ts","sourceRoot":"","sources":["../../src/DataGrid/Table.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAiB,YAAY,EAAmB,MAAM,OAAO,CAAC;AAiB5E,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,GAAG,IAAI,OAAO,EAAE,MAAM,SAAS,CAAC;AAOhE,KAAK,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,OAAO,IAAI,IAAI,CACzD,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC,EACnB,UAAU,CACX,GAAG;IACF,QAAQ,CAAC,EAAE,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;CACzC,CAAC;AAEF,wBAAgB,KAAK,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,OAAO,EACvD,KAAK,EAAE,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,qBA8IxB"}

package/DataGrid/types.d.ts

@@ -2,16 +2,14 @@ import { AriaLabelingProps, Key, Selection, SelectionMode, SortDescriptor } from
 import { ReactNode } from "react";
 import { IconSymbol } from "../types";
 /** Denote that an object must contain a key. */
-export type KeyedObject = {
-    readonly key: Key;
+export type KeyedObject<K extends Key = Key> = {
+    readonly key: K;
 };
 export type Column = KeyedObject & {
     /** Arbitrary data is allowed. */
     [property: string]: unknown;
 };
-export type Row<C extends Column> = KeyedObject & {
-    [property in C["key"]]: unknown;
-};
+export type Row<D extends Record<string, unknown> = Record<string, unknown>> = KeyedObject & D;
 export type MenuRowAction = {
     type: "menu";
     /** Optional custom accessibility label describing the menu action. */
@@ -28,22 +26,27 @@ export type ActionRowAction = {
     /** Action to trigger. */
     onAction: () => void;
 };
+export type ColumnKey<C extends Column = Column> = C["key"];
+export type RowKey<R extends Row = Row> = R["key"];
+export type KeyedSortDescriptor<K extends Key = Key> = Omit<SortDescriptor, "column"> & {
+    column: K;
+};
 export type RowAction = MenuRowAction | ActionRowAction;
-export type DataGridProps<C extends Column = Column> = AriaLabelingProps & {
+export type DataGridProps<C extends Column = Column, R extends Row = Row> = AriaLabelingProps & {
     /** Use columns and rows to specify data grid content. */
     children?: never;
     /** List of keys for columns to allow sort. */
-    columnKeysAllowingSort?: Key[];
+    columnKeysAllowingSort?: ColumnKey<C>[];
     /** Columns for the table. */
     columns: C[];
     /** The initial expanded key in the collection (uncontrolled). */
-    defaultExpandedKey?: Key;
+    defaultExpandedKey?: RowKey<R>;
     /** The initial selected keys in the collection (uncontrolled). */
-    defaultSelectedKeys?: "all" | Iterable<Key>;
+    defaultSelectedKeys?: "all" | Iterable<RowKey<R>>;
     /** A list of row keys to disable from selection. */
-    disabledKeys?: Iterable<Key>;
+    disabledKeys?: Iterable<RowKey<R>>;
     /** The currently expanded key in the collection (controlled). */
-    expandedKey?: Key;
+    expandedKey?: RowKey<R>;
     /**
      * Variant of the data grid header to use.
      * @default primary
@@ -52,27 +55,27 @@ export type DataGridProps<C extends Column = Column> = AriaLabelingProps & {
     /** Constrains the height of the data grid to a set number of rows. */
     maxRows?: number;
     /** Handler that is called when a user performs an action on the cell. */
-    onCellAction?: (key: Key) => void;
+    onCellAction?: (key: RowKey<R>) => void;
     /** Handler that is called when the expansion changes. */
-    onExpandedChange?: (key: Key) => void;
+    onExpandedChange?: (key: RowKey<R>) => void;
     /** Handler that is called when a user performs an action on the row. */
-    onRowAction?: (key: Key) => void;
+    onRowAction?: (key: RowKey<R>) => void;
     /** Handler that is called when the selection changes. */
     onSelectionChange?: (keys: Selection) => void;
     /** Handler that is called when the sorted column or direction changes. */
-    onSortChange?: (descriptor: SortDescriptor) => void;
+    onSortChange?: (descriptor: KeyedSortDescriptor<ColumnKey<C>>) => void;
     /** Renders the content of a column cell. */
     renderColumnCell: (cell: C) => ReactNode;
     /** Renders the contents of the expanded row. */
-    renderExpandedRow?: (key: Key) => ReactNode;
+    renderExpandedRow?: (key: RowKey<R>) => ReactNode;
     /** Renders the content of a row cell. */
-    renderRowCell: (cell: unknown, columnKey: Key, row: Row<C>) => ReactNode;
+    renderRowCell: (cell: unknown, columnKey: ColumnKey<C>, row: R) => ReactNode;
     /** Actions for the row */
-    rowActions?: (key: Key) => RowAction[];
+    rowActions?: (key: RowKey<R>) => RowAction[];
     /** Rows for the table. */
-    rows: Row<C>[];
+    rows: R[];
     /** The currently selected keys in the collection (controlled). */
-    selectedKeys?: "all" | Iterable<Key>;
+    selectedKeys?: "all" | Iterable<RowKey<R>>;
     /** The type of selection that is allowed in the collection. */
     selectionMode?: SelectionMode;
     /**
@@ -81,7 +84,7 @@ export type DataGridProps<C extends Column = Column> = AriaLabelingProps & {
      */
     size?: "sm" | "md" | "lg";
     /** The current sorted column and direction. */
-    sortDescriptor?: SortDescriptor;
+    sortDescriptor?: KeyedSortDescriptor<ColumnKey<C>>;
     /**
      * Renders the content of empty state.
      * @default "No Data"

package/DataGrid/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/DataGrid/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,GAAG,EACH,SAAS,EACT,aAAa,EACb,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,gDAAgD;AAChD,MAAM,MAAM,WAAW,GAAG;IACxB,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG;IACjC,iCAAiC;IACjC,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,MAAM,IAAI,WAAW,GAAG;KAE/C,QAAQ,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,OAAO;CAChC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IAEb,sEAAsE;IACtE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,+BAA+B;IAC/B,iBAAiB,EAAE,MAAM,SAAS,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,QAAQ,CAAC;IAEf,wDAAwD;IACxD,kBAAkB,EAAE,MAAM,CAAC;IAE3B,kCAAkC;IAClC,UAAU,EAAE,UAAU,CAAC;IAEvB,yBAAyB;IACzB,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,eAAe,CAAC;AAExD,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,iBAAiB,GAAG;IACzE,yDAAyD;IACzD,QAAQ,CAAC,EAAE,KAAK,CAAC;IAEjB,8CAA8C;IAC9C,sBAAsB,CAAC,EAAE,GAAG,EAAE,CAAC;IAE/B,6BAA6B;IAC7B,OAAO,EAAE,CAAC,EAAE,CAAC;IAEb,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,GAAG,CAAC;IAEzB,kEAAkE;IAClE,mBAAmB,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAE5C,oDAAoD;IACpD,YAAY,CAAC,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC;IAE7B,iEAAiE;IACjE,WAAW,CAAC,EAAE,GAAG,CAAC;IAElB;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,YAAY,CAAC;IAEvD,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,yEAAyE;IACzE,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;IAElC,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;IAEtC,wEAAwE;IACxE,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;IAEjC,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;IAE9C,0EAA0E;IAC1E,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,cAAc,KAAK,IAAI,CAAC;IAEpD,4CAA4C;IAC5C,gBAAgB,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,SAAS,CAAC;IAEzC,gDAAgD;IAChD,iBAAiB,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,SAAS,CAAC;IAE5C,yCAAyC;IACzC,aAAa,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;IAEzE,0BAA0B;IAC1B,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,SAAS,EAAE,CAAC;IAEvC,0BAA0B;IAC1B,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAEf,kEAAkE;IAClE,YAAY,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAErC,+DAA+D;IAC/D,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;;OAGG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAE1B,+CAA+C;IAC/C,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,SAAS,CAAC;IAEnC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/DataGrid/types.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,GAAG,EACH,SAAS,EACT,aAAa,EACb,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,gDAAgD;AAChD,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI;IAC7C,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG,WAAW,GAAG;IACjC,iCAAiC;IACjC,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACzE,WAAW,GAAG,CAAC,CAAC;AAElB,MAAM,MAAM,aAAa,GAAG;IAC1B,IAAI,EAAE,MAAM,CAAC;IAEb,sEAAsE;IACtE,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,+BAA+B;IAC/B,iBAAiB,EAAE,MAAM,SAAS,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,IAAI,EAAE,QAAQ,CAAC;IAEf,wDAAwD;IACxD,kBAAkB,EAAE,MAAM,CAAC;IAE3B,kCAAkC;IAClC,UAAU,EAAE,UAAU,CAAC;IAEvB,yBAAyB;IACzB,QAAQ,EAAE,MAAM,IAAI,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;AAC5D,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC;AAEnD,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,IAAI,CACzD,cAAc,EACd,QAAQ,CACT,GAAG;IACF,MAAM,EAAE,CAAC,CAAC;CACX,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG,eAAe,CAAC;AAExD,MAAM,MAAM,aAAa,CACvB,CAAC,SAAS,MAAM,GAAG,MAAM,EACzB,CAAC,SAAS,GAAG,GAAG,GAAG,IACjB,iBAAiB,GAAG;IACtB,yDAAyD;IACzD,QAAQ,CAAC,EAAE,KAAK,CAAC;IAEjB,8CAA8C;IAC9C,sBAAsB,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IAExC,6BAA6B;IAC7B,OAAO,EAAE,CAAC,EAAE,CAAC;IAEb,iEAAiE;IACjE,kBAAkB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAE/B,kEAAkE;IAClE,mBAAmB,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAElD,oDAAoD;IACpD,YAAY,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAEnC,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;IAExB;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,YAAY,CAAC;IAEvD,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,yEAAyE;IACzE,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAExC,yDAAyD;IACzD,gBAAgB,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAE5C,wEAAwE;IACxE,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAEvC,yDAAyD;IACzD,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;IAE9C,0EAA0E;IAC1E,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAEvE,4CAA4C;IAC5C,gBAAgB,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,SAAS,CAAC;IAEzC,gDAAgD;IAChD,iBAAiB,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC;IAElD,yCAAyC;IACzC,aAAa,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,KAAK,SAAS,CAAC;IAE7E,0BAA0B;IAC1B,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;IAE7C,0BAA0B;IAC1B,IAAI,EAAE,CAAC,EAAE,CAAC;IAEV,kEAAkE;IAClE,YAAY,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAE3C,+DAA+D;IAC/D,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;;OAGG;IACH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IAE1B,+CAA+C;IAC/C,cAAc,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAEnD;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,SAAS,CAAC;IAEnC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easypost/easy-ui",
-  "version": "1.0.0-alpha.77",
+  "version": "1.0.0-alpha.78",
   "sideEffects": [
     "**/*.css"
   ],