@osdk/react-components 0.40.0 → 0.41.0-main-7e4163b0319ea02499200d07dc4969e11a5cb33c
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/build/browser/object-table/ColumnConfigDialog.js +20 -15
- package/build/browser/object-table/ColumnConfigDialog.js.map +1 -1
- package/build/browser/object-table/EditableCell.js +4 -3
- package/build/browser/object-table/EditableCell.js.map +1 -1
- package/build/browser/object-table/MultiColumnSortDialog.js +15 -12
- package/build/browser/object-table/MultiColumnSortDialog.js.map +1 -1
- package/build/browser/object-table/ObjectTable.js +3 -1
- package/build/browser/object-table/ObjectTable.js.map +1 -1
- package/build/browser/object-table/ObjectTableApi.js.map +1 -1
- package/build/browser/object-table/ObjectTableLabels.js +130 -0
- package/build/browser/object-table/ObjectTableLabels.js.map +1 -0
- package/build/browser/object-table/SelectionCells.js +5 -2
- package/build/browser/object-table/SelectionCells.js.map +1 -1
- package/build/browser/object-table/Table.js +7 -3
- package/build/browser/object-table/Table.js.map +1 -1
- package/build/browser/object-table/TableEditContainer.js +8 -6
- package/build/browser/object-table/TableEditContainer.js.map +1 -1
- package/build/browser/object-table/TableHeaderWithPopover.js +11 -9
- package/build/browser/object-table/TableHeaderWithPopover.js.map +1 -1
- package/build/browser/object-table/components/AsyncValueCell.js +4 -2
- package/build/browser/object-table/components/AsyncValueCell.js.map +1 -1
- package/build/browser/public/experimental/object-table.js.map +1 -1
- package/build/browser/util/UserAgent.js +1 -1
- package/build/browser/util/UserAgent.js.map +1 -1
- package/build/cjs/chunk-323YOMG2.cjs +11 -0
- package/build/cjs/{chunk-4YFH7US6.cjs.map → chunk-323YOMG2.cjs.map} +1 -1
- package/build/cjs/{chunk-AY3WIKRW.cjs → chunk-4SGNGOAP.cjs} +490 -397
- package/build/cjs/chunk-4SGNGOAP.cjs.map +1 -0
- package/build/cjs/{chunk-5U23QYOL.cjs → chunk-6UIKJ4X4.cjs} +4 -4
- package/build/cjs/{chunk-5U23QYOL.cjs.map → chunk-6UIKJ4X4.cjs.map} +1 -1
- package/build/cjs/{chunk-PMQT5CIV.cjs → chunk-74V4AJ4A.cjs} +4 -4
- package/build/cjs/{chunk-PMQT5CIV.cjs.map → chunk-74V4AJ4A.cjs.map} +1 -1
- package/build/cjs/chunk-CWOMGAE4.cjs +11 -0
- package/build/cjs/{chunk-GNOUY65C.cjs.map → chunk-CWOMGAE4.cjs.map} +1 -1
- package/build/cjs/chunk-EMR3I6AL.cjs +11 -0
- package/build/cjs/{chunk-6U4W2HH5.cjs.map → chunk-EMR3I6AL.cjs.map} +1 -1
- package/build/cjs/{chunk-CEDJUDDR.cjs → chunk-GIKFNRWU.cjs} +4 -4
- package/build/cjs/{chunk-CEDJUDDR.cjs.map → chunk-GIKFNRWU.cjs.map} +1 -1
- package/build/cjs/{chunk-UQM4DWUN.cjs → chunk-GNXZZXHI.cjs} +3 -3
- package/build/cjs/chunk-GNXZZXHI.cjs.map +1 -0
- package/build/cjs/{chunk-ZKLRFU6R.cjs → chunk-JQAAJFKE.cjs} +4 -4
- package/build/cjs/{chunk-ZKLRFU6R.cjs.map → chunk-JQAAJFKE.cjs.map} +1 -1
- package/build/cjs/{chunk-IA32Z765.cjs → chunk-LIJJHXK6.cjs} +4 -4
- package/build/cjs/{chunk-IA32Z765.cjs.map → chunk-LIJJHXK6.cjs.map} +1 -1
- package/build/cjs/{chunk-MJC5CXYJ.cjs → chunk-LKDGFSTS.cjs} +4 -4
- package/build/cjs/{chunk-MJC5CXYJ.cjs.map → chunk-LKDGFSTS.cjs.map} +1 -1
- package/build/cjs/{chunk-PXCVMAUL.cjs → chunk-V2YDHJFF.cjs} +4 -4
- package/build/cjs/{chunk-PXCVMAUL.cjs.map → chunk-V2YDHJFF.cjs.map} +1 -1
- package/build/cjs/chunk-VOLJ5FDD.cjs +11 -0
- package/build/cjs/{chunk-XEDHHJ5U.cjs.map → chunk-VOLJ5FDD.cjs.map} +1 -1
- package/build/cjs/chunk-YXCVZKTN.cjs +11 -0
- package/build/cjs/{chunk-ACLCVBDB.cjs.map → chunk-YXCVZKTN.cjs.map} +1 -1
- package/build/cjs/public/experimental/action-form.cjs +4 -4
- package/build/cjs/public/experimental/cbac-picker.cjs +11 -11
- package/build/cjs/public/experimental/document-viewer.cjs +4 -4
- package/build/cjs/public/experimental/email-viewer.cjs +3 -3
- package/build/cjs/public/experimental/excel-viewer.cjs +3 -3
- package/build/cjs/public/experimental/filter-list.cjs +15 -15
- package/build/cjs/public/experimental/image-viewer.cjs +3 -3
- package/build/cjs/public/experimental/markdown-renderer.cjs +3 -3
- package/build/cjs/public/experimental/object-table.cjs +21 -21
- package/build/cjs/public/experimental/object-table.d.cts +136 -4
- package/build/cjs/public/experimental/pdf-viewer.cjs +7 -7
- package/build/cjs/public/experimental/tiff-renderer.cjs +3 -3
- package/build/cjs/public/experimental/video-viewer.cjs +3 -3
- package/build/cjs/public/experimental/xml-viewer.cjs +3 -3
- package/build/cjs/public/experimental.cjs +71 -71
- package/build/cjs/public/experimental.d.cts +1 -1
- package/build/esm/object-table/ColumnConfigDialog.js +20 -15
- package/build/esm/object-table/ColumnConfigDialog.js.map +1 -1
- package/build/esm/object-table/EditableCell.js +4 -3
- package/build/esm/object-table/EditableCell.js.map +1 -1
- package/build/esm/object-table/MultiColumnSortDialog.js +15 -12
- package/build/esm/object-table/MultiColumnSortDialog.js.map +1 -1
- package/build/esm/object-table/ObjectTable.js +3 -1
- package/build/esm/object-table/ObjectTable.js.map +1 -1
- package/build/esm/object-table/ObjectTableApi.js.map +1 -1
- package/build/esm/object-table/ObjectTableLabels.js +130 -0
- package/build/esm/object-table/ObjectTableLabels.js.map +1 -0
- package/build/esm/object-table/SelectionCells.js +5 -2
- package/build/esm/object-table/SelectionCells.js.map +1 -1
- package/build/esm/object-table/Table.js +7 -3
- package/build/esm/object-table/Table.js.map +1 -1
- package/build/esm/object-table/TableEditContainer.js +8 -6
- package/build/esm/object-table/TableEditContainer.js.map +1 -1
- package/build/esm/object-table/TableHeaderWithPopover.js +11 -9
- package/build/esm/object-table/TableHeaderWithPopover.js.map +1 -1
- package/build/esm/object-table/components/AsyncValueCell.js +4 -2
- package/build/esm/object-table/components/AsyncValueCell.js.map +1 -1
- package/build/esm/public/experimental/object-table.js.map +1 -1
- package/build/esm/util/UserAgent.js +1 -1
- package/build/esm/util/UserAgent.js.map +1 -1
- package/build/types/object-table/ColumnConfigDialog.d.ts +10 -1
- package/build/types/object-table/ColumnConfigDialog.d.ts.map +1 -1
- package/build/types/object-table/EditableCell.d.ts.map +1 -1
- package/build/types/object-table/MultiColumnSortDialog.d.ts +10 -1
- package/build/types/object-table/MultiColumnSortDialog.d.ts.map +1 -1
- package/build/types/object-table/ObjectTable.d.ts +1 -1
- package/build/types/object-table/ObjectTable.d.ts.map +1 -1
- package/build/types/object-table/ObjectTableApi.d.ts +9 -0
- package/build/types/object-table/ObjectTableApi.d.ts.map +1 -1
- package/build/types/object-table/ObjectTableLabels.d.ts +135 -0
- package/build/types/object-table/ObjectTableLabels.d.ts.map +1 -0
- package/build/types/object-table/SelectionCells.d.ts.map +1 -1
- package/build/types/object-table/Table.d.ts +7 -0
- package/build/types/object-table/Table.d.ts.map +1 -1
- package/build/types/object-table/TableEditContainer.d.ts.map +1 -1
- package/build/types/object-table/TableHeaderWithPopover.d.ts.map +1 -1
- package/build/types/object-table/components/AsyncValueCell.d.ts.map +1 -1
- package/build/types/public/experimental/object-table.d.ts +1 -0
- package/build/types/public/experimental/object-table.d.ts.map +1 -1
- package/docs/ObjectTable.md +1 -0
- package/package.json +6 -6
- package/build/cjs/chunk-4YFH7US6.cjs +0 -11
- package/build/cjs/chunk-6U4W2HH5.cjs +0 -11
- package/build/cjs/chunk-ACLCVBDB.cjs +0 -11
- package/build/cjs/chunk-AY3WIKRW.cjs.map +0 -1
- package/build/cjs/chunk-GNOUY65C.cjs +0 -11
- package/build/cjs/chunk-UQM4DWUN.cjs.map +0 -1
- package/build/cjs/chunk-XEDHHJ5U.cjs +0 -11
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ObjectTable.js","names":["getCoreRowModel","useReactTable","React","useCallback","useImperativeHandle","useMemo","useColumnDefs","useColumnPinning","useColumnResize","useColumnVisibility","useEditableTable","useObjectTableData","useObjectTableSnapshot","useRowSelection","useSelectionColumn","useTableSorting","BaseTable","deriveSelectionObjectSet","getRowId","getRowIdFromPrimaryKey","EMPTY_ARRAY","ObjectTable","objectType","objectSet","columnDefinitions","filter","objectSetOptions","dedupeIntervalMs","pageSize","streamUpdates","orderBy","defaultOrderBy","onOrderByChanged","onColumnsPinnedChanged","onColumnResize","onRowSelectionChanged","onColumnHeaderClick","renderCellContextMenu","selectionMode","selectedRows","isAllSelected","isAllSelectedProp","onColumnVisibilityChanged","onCellValueChanged","onSubmitEdits","enableOrdering","enableColumnPinning","enableColumnResizing","enableColumnConfig","editMode","focusedRow","onFocusedRowChanged","tableRef","props","columnSizing","onColumnSizingChange","sorting","onSortingChange","orderByState","data","fetchMore","isLoading","error","totalCount","resultingObjectSet","objectOrInterfaceType","columns","loading","isColumnsLoading","handleRowSelectionChanged","change","isSelectAll","rowSelection","hasSelection","onToggleAll","onToggleRow","enableRowSelection","selectionColumn","columnVisibility","onColumnVisibilityChange","columnOrder","onColumnOrderChange","allColumns","columnPinning","onColumnPinningChange","hasSelectionColumn","editableConfig","table","state","enableSorting","columnResizeMode","columnResizeDirection","manualSorting","defaultColumn","minSize","meta","onCellEdit","onCellValidationError","clearCellValidationError","cellEdits","isInEditMode","editModeState","isActive","validationErrors","getSnapshot","onRenderCellContextMenu","row","cell","getValue","handleColumnHeaderClick","columnId","undefined","headerMenuFeatureFlags","showSortingItems","showPinningItems","showResizeItem","showConfigItem","createElement","fetchNextPage","onRowClick","rowHeight","renderEmptyState","className","getRowAttributes","showEditFooter","focusedRowId"],"sources":["ObjectTable.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n ObjectOrInterfaceDefinition,\n Osdk,\n PropertyKeys,\n QueryDefinition,\n SimplePropertyDef,\n} from \"@osdk/api\";\nimport type { Cell } from \"@tanstack/react-table\";\nimport { getCoreRowModel, useReactTable } from \"@tanstack/react-table\";\nimport React, { useCallback, useImperativeHandle, useMemo } from \"react\";\n\nimport { useColumnDefs } from \"./hooks/useColumnDefs.js\";\nimport { useColumnPinning } from \"./hooks/useColumnPinning.js\";\nimport { useColumnResize } from \"./hooks/useColumnResize.js\";\nimport { useColumnVisibility } from \"./hooks/useColumnVisibility.js\";\nimport { useEditableTable } from \"./hooks/useEditableTable.js\";\nimport { useObjectTableData } from \"./hooks/useObjectTableData.js\";\nimport { useObjectTableSnapshot } from \"./hooks/useObjectTableSnapshot.js\";\nimport type { UseRowSelectionChange } from \"./hooks/useRowSelection.js\";\nimport { useRowSelection } from \"./hooks/useRowSelection.js\";\nimport { useSelectionColumn } from \"./hooks/useSelectionColumn.js\";\nimport { useTableSorting } from \"./hooks/useTableSorting.js\";\nimport type { ObjectTableProps } from \"./ObjectTableApi.js\";\nimport { BaseTable } from \"./Table.js\";\nimport type { HeaderMenuFeatureFlags } from \"./TableHeaderWithPopover.js\";\nimport { deriveSelectionObjectSet } from \"./utils/deriveSelectionObjectSet.js\";\nimport { getRowId, getRowIdFromPrimaryKey } from \"./utils/getRowId.js\";\nimport type { EditableConfig } from \"./utils/types.js\";\n\nconst EMPTY_ARRAY: [] = [];\n\nexport function ObjectTable<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n>({\n objectType,\n objectSet,\n columnDefinitions,\n filter,\n objectSetOptions,\n dedupeIntervalMs,\n pageSize,\n streamUpdates,\n orderBy,\n defaultOrderBy,\n onOrderByChanged,\n onColumnsPinnedChanged,\n onColumnResize,\n onRowSelectionChanged,\n onColumnHeaderClick,\n renderCellContextMenu,\n selectionMode = \"none\",\n selectedRows,\n isAllSelected: isAllSelectedProp,\n onColumnVisibilityChanged,\n onCellValueChanged,\n onSubmitEdits,\n enableOrdering = true,\n enableColumnPinning = true,\n enableColumnResizing = true,\n enableColumnConfig = true,\n editMode = \"manual\",\n focusedRow,\n onFocusedRowChanged,\n tableRef,\n ...props\n}: ObjectTableProps<Q, RDPs, FunctionColumns>): React.ReactElement {\n const { columnSizing, onColumnSizingChange } = useColumnResize({\n onColumnResize,\n });\n\n const { sorting, onSortingChange, orderByState } = useTableSorting<\n Q,\n RDPs,\n FunctionColumns\n >({\n orderBy,\n defaultOrderBy,\n onOrderByChanged,\n });\n\n const {\n data,\n fetchMore,\n isLoading,\n error,\n totalCount,\n objectSet: resultingObjectSet,\n } = useObjectTableData<Q, RDPs, FunctionColumns>({\n objectOrInterfaceType: objectType,\n columnDefinitions,\n filter,\n sorting,\n objectSet,\n objectSetOptions,\n dedupeIntervalMs,\n pageSize,\n streamUpdates,\n });\n\n const { columns, loading: isColumnsLoading } = useColumnDefs<\n Q,\n RDPs,\n FunctionColumns\n >(objectType, columnDefinitions);\n\n const handleRowSelectionChanged = useCallback(\n (change: UseRowSelectionChange<Q, RDPs>) => {\n if (!onRowSelectionChanged) return;\n\n onRowSelectionChanged({\n selectedRows: change.selectedRows,\n isSelectAll: change.isSelectAll,\n objectSet: deriveSelectionObjectSet(resultingObjectSet, change),\n });\n },\n [onRowSelectionChanged, resultingObjectSet]\n );\n\n const {\n rowSelection,\n isAllSelected,\n hasSelection,\n onToggleAll,\n onToggleRow,\n enableRowSelection,\n } = useRowSelection<Q, RDPs>({\n selectionMode,\n selectedRows,\n isAllSelected: isAllSelectedProp,\n onRowSelectionChanged: handleRowSelectionChanged,\n data,\n });\n\n const selectionColumn = useSelectionColumn<Q, RDPs>({\n selectionMode,\n isAllSelected,\n hasSelection,\n onToggleAll,\n onToggleRow,\n });\n\n const {\n columnVisibility,\n onColumnVisibilityChange,\n columnOrder,\n onColumnOrderChange,\n } = useColumnVisibility({\n allColumns: columns,\n onColumnVisibilityChanged,\n });\n\n const { columnPinning, onColumnPinningChange } = useColumnPinning({\n columnDefinitions,\n hasSelectionColumn: enableRowSelection,\n onColumnsPinnedChanged,\n });\n\n const allColumns = useMemo(() => {\n return selectionColumn ? [selectionColumn, ...columns] : columns;\n }, [selectionColumn, columns]);\n\n const editableConfig: EditableConfig<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n unknown\n > = useEditableTable({\n editMode,\n onCellValueChanged,\n onSubmitEdits,\n });\n\n const table = useReactTable<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n >({\n data: data ?? EMPTY_ARRAY,\n columns: allColumns,\n getCoreRowModel: getCoreRowModel(),\n state: {\n columnVisibility,\n columnOrder,\n rowSelection,\n sorting,\n columnSizing,\n columnPinning,\n },\n onSortingChange,\n onColumnSizingChange,\n onColumnPinningChange,\n onColumnVisibilityChange,\n onColumnOrderChange,\n enableRowSelection,\n enableSorting: enableOrdering,\n columnResizeMode: \"onChange\",\n columnResizeDirection: \"ltr\",\n manualSorting: true, // Enable manual sorting to indicate server-side sorting\n defaultColumn: {\n minSize: 80,\n },\n getRowId,\n meta: {\n onCellEdit: editableConfig.onCellEdit,\n onCellValidationError: editableConfig.onCellValidationError,\n clearCellValidationError: editableConfig.clearCellValidationError,\n cellEdits: editableConfig.cellEdits,\n isInEditMode: editableConfig.editModeState.isActive,\n validationErrors: editableConfig.validationErrors,\n },\n });\n\n const { getSnapshot } = useObjectTableSnapshot<Q, RDPs, FunctionColumns>({\n objectOrInterfaceType: objectType,\n table,\n columnDefinitions,\n objectSet: resultingObjectSet,\n pageSize,\n totalCount,\n orderBy: orderByState,\n });\n\n useImperativeHandle(tableRef, () => ({ getSnapshot }), [getSnapshot]);\n\n const onRenderCellContextMenu = useCallback(\n (\n row: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n cell: Cell<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n unknown\n >\n ) => {\n return renderCellContextMenu?.(row, cell.getValue());\n },\n [renderCellContextMenu]\n );\n\n const handleColumnHeaderClick = useMemo(\n () =>\n onColumnHeaderClick\n ? (columnId: string) =>\n onColumnHeaderClick(\n columnId as PropertyKeys<Q> | keyof RDPs | keyof FunctionColumns\n )\n : undefined,\n [onColumnHeaderClick]\n );\n\n const isTableLoading = isLoading || isColumnsLoading;\n\n const headerMenuFeatureFlags: HeaderMenuFeatureFlags = useMemo(\n () => ({\n showSortingItems: enableOrdering,\n showPinningItems: enableColumnPinning,\n showResizeItem: enableColumnResizing,\n showConfigItem: enableColumnConfig,\n }),\n [\n enableOrdering,\n enableColumnPinning,\n enableColumnResizing,\n enableColumnConfig,\n ]\n );\n\n return (\n <BaseTable<Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>>\n table={table}\n isLoading={isTableLoading}\n fetchNextPage={fetchMore}\n onRowClick={props.onRowClick}\n onColumnHeaderClick={handleColumnHeaderClick}\n rowHeight={props.rowHeight}\n renderCellContextMenu={onRenderCellContextMenu}\n renderEmptyState={props.renderEmptyState}\n className={props.className}\n error={error}\n headerMenuFeatureFlags={headerMenuFeatureFlags}\n editableConfig={editableConfig}\n getRowAttributes={props.getRowAttributes}\n showEditFooter={props.showEditFooter}\n focusedRowId={\n focusedRow == null ? focusedRow : getRowIdFromPrimaryKey<Q>(focusedRow)\n }\n onFocusedRowChanged={onFocusedRowChanged}\n />\n );\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,SAASA,eAAe,EAAEC,aAAa,QAAQ,uBAAuB;AACtE,OAAOC,KAAK,IAAIC,WAAW,EAAEC,mBAAmB,EAAEC,OAAO,QAAQ,OAAO;AAExE,SAASC,aAAa,QAAQ,0BAA0B;AACxD,SAASC,gBAAgB,QAAQ,6BAA6B;AAC9D,SAASC,eAAe,QAAQ,4BAA4B;AAC5D,SAASC,mBAAmB,QAAQ,gCAAgC;AACpE,SAASC,gBAAgB,QAAQ,6BAA6B;AAC9D,SAASC,kBAAkB,QAAQ,+BAA+B;AAClE,SAASC,sBAAsB,QAAQ,mCAAmC;AAE1E,SAASC,eAAe,QAAQ,4BAA4B;AAC5D,SAASC,kBAAkB,QAAQ,+BAA+B;AAClE,SAASC,eAAe,QAAQ,4BAA4B;AAE5D,SAASC,SAAS,QAAQ,YAAY;AAEtC,SAASC,wBAAwB,QAAQ,qCAAqC;AAC9E,SAASC,QAAQ,EAAEC,sBAAsB,QAAQ,qBAAqB;AAGtE,MAAMC,WAAe,GAAG,EAAE;AAE1B,OAAO,SAASC,WAAWA,CAOzB;EACAC,UAAU;EACVC,SAAS;EACTC,iBAAiB;EACjBC,MAAM;EACNC,gBAAgB;EAChBC,gBAAgB;EAChBC,QAAQ;EACRC,aAAa;EACbC,OAAO;EACPC,cAAc;EACdC,gBAAgB;EAChBC,sBAAsB;EACtBC,cAAc;EACdC,qBAAqB;EACrBC,mBAAmB;EACnBC,qBAAqB;EACrBC,aAAa,GAAG,MAAM;EACtBC,YAAY;EACZC,aAAa,EAAEC,iBAAiB;EAChCC,yBAAyB;EACzBC,kBAAkB;EAClBC,aAAa;EACbC,cAAc,GAAG,IAAI;EACrBC,mBAAmB,GAAG,IAAI;EAC1BC,oBAAoB,GAAG,IAAI;EAC3BC,kBAAkB,GAAG,IAAI;EACzBC,QAAQ,GAAG,QAAQ;EACnBC,UAAU;EACVC,mBAAmB;EACnBC,QAAQ;EACR,GAAGC;AACuC,CAAC,EAAsB;EACjE,MAAM;IAAEC,YAAY;IAAEC;EAAqB,CAAC,GAAG/C,eAAe,CAAC;IAC7D0B;EACF,CAAC,CAAC;EAEF,MAAM;IAAEsB,OAAO;IAAEC,eAAe;IAAEC;EAAa,CAAC,GAAG3C,eAAe,CAIhE;IACAe,OAAO;IACPC,cAAc;IACdC;EACF,CAAC,CAAC;EAEF,MAAM;IACJ2B,IAAI;IACJC,SAAS;IACTC,SAAS;IACTC,KAAK;IACLC,UAAU;IACVxC,SAAS,EAAEyC;EACb,CAAC,GAAGrD,kBAAkB,CAA2B;IAC/CsD,qBAAqB,EAAE3C,UAAU;IACjCE,iBAAiB;IACjBC,MAAM;IACN+B,OAAO;IACPjC,SAAS;IACTG,gBAAgB;IAChBC,gBAAgB;IAChBC,QAAQ;IACRC;EACF,CAAC,CAAC;EAEF,MAAM;IAAEqC,OAAO;IAAEC,OAAO,EAAEC;EAAiB,CAAC,GAAG9D,aAAa,CAI1DgB,UAAU,EAAEE,iBAAiB,CAAC;EAEhC,MAAM6C,yBAAyB,GAAGlE,WAAW,CAC1CmE,MAAsC,IAAK;IAC1C,IAAI,CAACnC,qBAAqB,EAAE;IAE5BA,qBAAqB,CAAC;MACpBI,YAAY,EAAE+B,MAAM,CAAC/B,YAAY;MACjCgC,WAAW,EAAED,MAAM,CAACC,WAAW;MAC/BhD,SAAS,EAAEN,wBAAwB,CAAC+C,kBAAkB,EAAEM,MAAM;IAChE,CAAC,CAAC;EACJ,CAAC,EACD,CAACnC,qBAAqB,EAAE6B,kBAAkB,CAC5C,CAAC;EAED,MAAM;IACJQ,YAAY;IACZhC,aAAa;IACbiC,YAAY;IACZC,WAAW;IACXC,WAAW;IACXC;EACF,CAAC,GAAG/D,eAAe,CAAU;IAC3ByB,aAAa;IACbC,YAAY;IACZC,aAAa,EAAEC,iBAAiB;IAChCN,qBAAqB,EAAEkC,yBAAyB;IAChDV;EACF,CAAC,CAAC;EAEF,MAAMkB,eAAe,GAAG/D,kBAAkB,CAAU;IAClDwB,aAAa;IACbE,aAAa;IACbiC,YAAY;IACZC,WAAW;IACXC;EACF,CAAC,CAAC;EAEF,MAAM;IACJG,gBAAgB;IAChBC,wBAAwB;IACxBC,WAAW;IACXC;EACF,CAAC,GAAGxE,mBAAmB,CAAC;IACtByE,UAAU,EAAEhB,OAAO;IACnBxB;EACF,CAAC,CAAC;EAEF,MAAM;IAAEyC,aAAa;IAAEC;EAAsB,CAAC,GAAG7E,gBAAgB,CAAC;IAChEiB,iBAAiB;IACjB6D,kBAAkB,EAAET,kBAAkB;IACtC3C;EACF,CAAC,CAAC;EAEF,MAAMiD,UAAU,GAAG7E,OAAO,CAAC,MAAM;IAC/B,OAAOwE,eAAe,GAAG,CAACA,eAAe,EAAE,GAAGX,OAAO,CAAC,GAAGA,OAAO;EAClE,CAAC,EAAE,CAACW,eAAe,EAAEX,OAAO,CAAC,CAAC;EAE9B,MAAMoB,cAGL,GAAG5E,gBAAgB,CAAC;IACnBuC,QAAQ;IACRN,kBAAkB;IAClBC;EACF,CAAC,CAAC;EAEF,MAAM2C,KAAK,GAAGtF,aAAa,CAEzB;IACA0D,IAAI,EAAEA,IAAI,IAAIvC,WAAW;IACzB8C,OAAO,EAAEgB,UAAU;IACnBlF,eAAe,EAAEA,eAAe,CAAC,CAAC;IAClCwF,KAAK,EAAE;MACLV,gBAAgB;MAChBE,WAAW;MACXR,YAAY;MACZhB,OAAO;MACPF,YAAY;MACZ6B;IACF,CAAC;IACD1B,eAAe;IACfF,oBAAoB;IACpB6B,qBAAqB;IACrBL,wBAAwB;IACxBE,mBAAmB;IACnBL,kBAAkB;IAClBa,aAAa,EAAE5C,cAAc;IAC7B6C,gBAAgB,EAAE,UAAU;IAC5BC,qBAAqB,EAAE,KAAK;IAC5BC,aAAa,EAAE,IAAI;IAAE;IACrBC,aAAa,EAAE;MACbC,OAAO,EAAE;IACX,CAAC;IACD5E,QAAQ;IACR6E,IAAI,EAAE;MACJC,UAAU,EAAEV,cAAc,CAACU,UAAU;MACrCC,qBAAqB,EAAEX,cAAc,CAACW,qBAAqB;MAC3DC,wBAAwB,EAAEZ,cAAc,CAACY,wBAAwB;MACjEC,SAAS,EAAEb,cAAc,CAACa,SAAS;MACnCC,YAAY,EAAEd,cAAc,CAACe,aAAa,CAACC,QAAQ;MACnDC,gBAAgB,EAAEjB,cAAc,CAACiB;IACnC;EACF,CAAC,CAAC;EAEF,MAAM;IAAEC;EAAY,CAAC,GAAG5F,sBAAsB,CAA2B;IACvEqD,qBAAqB,EAAE3C,UAAU;IACjCiE,KAAK;IACL/D,iBAAiB;IACjBD,SAAS,EAAEyC,kBAAkB;IAC7BpC,QAAQ;IACRmC,UAAU;IACVjC,OAAO,EAAE4B;EACX,CAAC,CAAC;EAEFtD,mBAAmB,CAACgD,QAAQ,EAAE,OAAO;IAAEoD;EAAY,CAAC,CAAC,EAAE,CAACA,WAAW,CAAC,CAAC;EAErE,MAAMC,uBAAuB,GAAGtG,WAAW,CACzC,CACEuG,GAAkE,EAClEC,IAGC,KACE;IACH,OAAOtE,qBAAqB,GAAGqE,GAAG,EAAEC,IAAI,CAACC,QAAQ,CAAC,CAAC,CAAC;EACtD,CAAC,EACD,CAACvE,qBAAqB,CACxB,CAAC;EAED,MAAMwE,uBAAuB,GAAGxG,OAAO,CACrC,MACE+B,mBAAmB,GACd0E,QAAgB,IACf1E,mBAAmB,CACjB0E,QACF,CAAC,GACHC,SAAS,EACf,CAAC3E,mBAAmB,CACtB,CAAC;EAID,MAAM4E,sBAA8C,GAAG3G,OAAO,CAC5D,OAAO;IACL4G,gBAAgB,EAAEpE,cAAc;IAChCqE,gBAAgB,EAAEpE,mBAAmB;IACrCqE,cAAc,EAAEpE,oBAAoB;IACpCqE,cAAc,EAAEpE;EAClB,CAAC,CAAC,EACF,CACEH,cAAc,EACdC,mBAAmB,EACnBC,oBAAoB,EACpBC,kBAAkB,CAEtB,CAAC;EAED,oBACE9C,KAAA,CAAAmH,aAAA,CAACrG,SAAS;IACRuE,KAAK,EAAEA,KAAM;IACb1B,SAAS,EApBUA,SAAS,IAAIO,gBAoBN;IAC1BkD,aAAa,EAAE1D,SAAU;IACzB2D,UAAU,EAAElE,KAAK,CAACkE,UAAW;IAC7BnF,mBAAmB,EAAEyE,uBAAwB;IAC7CW,SAAS,EAAEnE,KAAK,CAACmE,SAAU;IAC3BnF,qBAAqB,EAAEoE,uBAAwB;IAC/CgB,gBAAgB,EAAEpE,KAAK,CAACoE,gBAAiB;IACzCC,SAAS,EAAErE,KAAK,CAACqE,SAAU;IAC3B5D,KAAK,EAAEA,KAAM;IACbkD,sBAAsB,EAAEA,sBAAuB;IAC/C1B,cAAc,EAAEA,cAAe;IAC/BqC,gBAAgB,EAAEtE,KAAK,CAACsE,gBAAiB;IACzCC,cAAc,EAAEvE,KAAK,CAACuE,cAAe;IACrCC,YAAY,EACV3E,UAAU,IAAI,IAAI,GAAGA,UAAU,GAAG/B,sBAAsB,CAAI+B,UAAU,CACvE;IACDC,mBAAmB,EAAEA;EAAoB,CAC1C,CAAC;AAEN","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"ObjectTable.js","names":["getCoreRowModel","useReactTable","React","useCallback","useImperativeHandle","useMemo","useColumnDefs","useColumnPinning","useColumnResize","useColumnVisibility","useEditableTable","useObjectTableData","useObjectTableSnapshot","useRowSelection","useSelectionColumn","useTableSorting","BaseTable","deriveSelectionObjectSet","getRowId","getRowIdFromPrimaryKey","EMPTY_ARRAY","ObjectTable","objectType","objectSet","columnDefinitions","filter","objectSetOptions","dedupeIntervalMs","pageSize","streamUpdates","orderBy","defaultOrderBy","onOrderByChanged","onColumnsPinnedChanged","onColumnResize","onRowSelectionChanged","onColumnHeaderClick","renderCellContextMenu","selectionMode","selectedRows","isAllSelected","isAllSelectedProp","onColumnVisibilityChanged","onCellValueChanged","onSubmitEdits","enableOrdering","enableColumnPinning","enableColumnResizing","enableColumnConfig","editMode","focusedRow","onFocusedRowChanged","tableRef","labels","props","columnSizing","onColumnSizingChange","sorting","onSortingChange","orderByState","data","fetchMore","isLoading","error","totalCount","resultingObjectSet","objectOrInterfaceType","columns","loading","isColumnsLoading","handleRowSelectionChanged","change","isSelectAll","rowSelection","hasSelection","onToggleAll","onToggleRow","enableRowSelection","selectionColumn","columnVisibility","onColumnVisibilityChange","columnOrder","onColumnOrderChange","allColumns","columnPinning","onColumnPinningChange","hasSelectionColumn","editableConfig","table","state","enableSorting","columnResizeMode","columnResizeDirection","manualSorting","defaultColumn","minSize","meta","onCellEdit","onCellValidationError","clearCellValidationError","cellEdits","isInEditMode","editModeState","isActive","validationErrors","getSnapshot","onRenderCellContextMenu","row","cell","getValue","handleColumnHeaderClick","columnId","undefined","headerMenuFeatureFlags","showSortingItems","showPinningItems","showResizeItem","showConfigItem","createElement","fetchNextPage","onRowClick","rowHeight","renderEmptyState","className","getRowAttributes","showEditFooter","focusedRowId"],"sources":["ObjectTable.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n ObjectOrInterfaceDefinition,\n Osdk,\n PropertyKeys,\n QueryDefinition,\n SimplePropertyDef,\n} from \"@osdk/api\";\nimport type { Cell } from \"@tanstack/react-table\";\nimport { getCoreRowModel, useReactTable } from \"@tanstack/react-table\";\nimport React, { useCallback, useImperativeHandle, useMemo } from \"react\";\n\nimport { useColumnDefs } from \"./hooks/useColumnDefs.js\";\nimport { useColumnPinning } from \"./hooks/useColumnPinning.js\";\nimport { useColumnResize } from \"./hooks/useColumnResize.js\";\nimport { useColumnVisibility } from \"./hooks/useColumnVisibility.js\";\nimport { useEditableTable } from \"./hooks/useEditableTable.js\";\nimport { useObjectTableData } from \"./hooks/useObjectTableData.js\";\nimport { useObjectTableSnapshot } from \"./hooks/useObjectTableSnapshot.js\";\nimport type { UseRowSelectionChange } from \"./hooks/useRowSelection.js\";\nimport { useRowSelection } from \"./hooks/useRowSelection.js\";\nimport { useSelectionColumn } from \"./hooks/useSelectionColumn.js\";\nimport { useTableSorting } from \"./hooks/useTableSorting.js\";\nimport type { ObjectTableProps } from \"./ObjectTableApi.js\";\nimport { BaseTable } from \"./Table.js\";\nimport type { HeaderMenuFeatureFlags } from \"./TableHeaderWithPopover.js\";\nimport { deriveSelectionObjectSet } from \"./utils/deriveSelectionObjectSet.js\";\nimport { getRowId, getRowIdFromPrimaryKey } from \"./utils/getRowId.js\";\nimport type { EditableConfig } from \"./utils/types.js\";\n\nconst EMPTY_ARRAY: [] = [];\n\nexport function ObjectTable<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n>({\n objectType,\n objectSet,\n columnDefinitions,\n filter,\n objectSetOptions,\n dedupeIntervalMs,\n pageSize,\n streamUpdates,\n orderBy,\n defaultOrderBy,\n onOrderByChanged,\n onColumnsPinnedChanged,\n onColumnResize,\n onRowSelectionChanged,\n onColumnHeaderClick,\n renderCellContextMenu,\n selectionMode = \"none\",\n selectedRows,\n isAllSelected: isAllSelectedProp,\n onColumnVisibilityChanged,\n onCellValueChanged,\n onSubmitEdits,\n enableOrdering = true,\n enableColumnPinning = true,\n enableColumnResizing = true,\n enableColumnConfig = true,\n editMode = \"manual\",\n focusedRow,\n onFocusedRowChanged,\n tableRef,\n labels,\n ...props\n}: ObjectTableProps<Q, RDPs, FunctionColumns>): React.ReactElement {\n const { columnSizing, onColumnSizingChange } = useColumnResize({\n onColumnResize,\n });\n\n const { sorting, onSortingChange, orderByState } = useTableSorting<\n Q,\n RDPs,\n FunctionColumns\n >({\n orderBy,\n defaultOrderBy,\n onOrderByChanged,\n });\n\n const {\n data,\n fetchMore,\n isLoading,\n error,\n totalCount,\n objectSet: resultingObjectSet,\n } = useObjectTableData<Q, RDPs, FunctionColumns>({\n objectOrInterfaceType: objectType,\n columnDefinitions,\n filter,\n sorting,\n objectSet,\n objectSetOptions,\n dedupeIntervalMs,\n pageSize,\n streamUpdates,\n });\n\n const { columns, loading: isColumnsLoading } = useColumnDefs<\n Q,\n RDPs,\n FunctionColumns\n >(objectType, columnDefinitions);\n\n const handleRowSelectionChanged = useCallback(\n (change: UseRowSelectionChange<Q, RDPs>) => {\n if (!onRowSelectionChanged) return;\n\n onRowSelectionChanged({\n selectedRows: change.selectedRows,\n isSelectAll: change.isSelectAll,\n objectSet: deriveSelectionObjectSet(resultingObjectSet, change),\n });\n },\n [onRowSelectionChanged, resultingObjectSet]\n );\n\n const {\n rowSelection,\n isAllSelected,\n hasSelection,\n onToggleAll,\n onToggleRow,\n enableRowSelection,\n } = useRowSelection<Q, RDPs>({\n selectionMode,\n selectedRows,\n isAllSelected: isAllSelectedProp,\n onRowSelectionChanged: handleRowSelectionChanged,\n data,\n });\n\n const selectionColumn = useSelectionColumn<Q, RDPs>({\n selectionMode,\n isAllSelected,\n hasSelection,\n onToggleAll,\n onToggleRow,\n });\n\n const {\n columnVisibility,\n onColumnVisibilityChange,\n columnOrder,\n onColumnOrderChange,\n } = useColumnVisibility({\n allColumns: columns,\n onColumnVisibilityChanged,\n });\n\n const { columnPinning, onColumnPinningChange } = useColumnPinning({\n columnDefinitions,\n hasSelectionColumn: enableRowSelection,\n onColumnsPinnedChanged,\n });\n\n const allColumns = useMemo(() => {\n return selectionColumn ? [selectionColumn, ...columns] : columns;\n }, [selectionColumn, columns]);\n\n const editableConfig: EditableConfig<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n unknown\n > = useEditableTable({\n editMode,\n onCellValueChanged,\n onSubmitEdits,\n });\n\n const table = useReactTable<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n >({\n data: data ?? EMPTY_ARRAY,\n columns: allColumns,\n getCoreRowModel: getCoreRowModel(),\n state: {\n columnVisibility,\n columnOrder,\n rowSelection,\n sorting,\n columnSizing,\n columnPinning,\n },\n onSortingChange,\n onColumnSizingChange,\n onColumnPinningChange,\n onColumnVisibilityChange,\n onColumnOrderChange,\n enableRowSelection,\n enableSorting: enableOrdering,\n columnResizeMode: \"onChange\",\n columnResizeDirection: \"ltr\",\n manualSorting: true, // Enable manual sorting to indicate server-side sorting\n defaultColumn: {\n minSize: 80,\n },\n getRowId,\n meta: {\n onCellEdit: editableConfig.onCellEdit,\n onCellValidationError: editableConfig.onCellValidationError,\n clearCellValidationError: editableConfig.clearCellValidationError,\n cellEdits: editableConfig.cellEdits,\n isInEditMode: editableConfig.editModeState.isActive,\n validationErrors: editableConfig.validationErrors,\n },\n });\n\n const { getSnapshot } = useObjectTableSnapshot<Q, RDPs, FunctionColumns>({\n objectOrInterfaceType: objectType,\n table,\n columnDefinitions,\n objectSet: resultingObjectSet,\n pageSize,\n totalCount,\n orderBy: orderByState,\n });\n\n useImperativeHandle(tableRef, () => ({ getSnapshot }), [getSnapshot]);\n\n const onRenderCellContextMenu = useCallback(\n (\n row: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n cell: Cell<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n unknown\n >\n ) => {\n return renderCellContextMenu?.(row, cell.getValue());\n },\n [renderCellContextMenu]\n );\n\n const handleColumnHeaderClick = useMemo(\n () =>\n onColumnHeaderClick\n ? (columnId: string) =>\n onColumnHeaderClick(\n columnId as PropertyKeys<Q> | keyof RDPs | keyof FunctionColumns\n )\n : undefined,\n [onColumnHeaderClick]\n );\n\n const isTableLoading = isLoading || isColumnsLoading;\n\n const headerMenuFeatureFlags: HeaderMenuFeatureFlags = useMemo(\n () => ({\n showSortingItems: enableOrdering,\n showPinningItems: enableColumnPinning,\n showResizeItem: enableColumnResizing,\n showConfigItem: enableColumnConfig,\n }),\n [\n enableOrdering,\n enableColumnPinning,\n enableColumnResizing,\n enableColumnConfig,\n ]\n );\n\n return (\n <BaseTable<Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>>\n table={table}\n isLoading={isTableLoading}\n fetchNextPage={fetchMore}\n onRowClick={props.onRowClick}\n onColumnHeaderClick={handleColumnHeaderClick}\n rowHeight={props.rowHeight}\n renderCellContextMenu={onRenderCellContextMenu}\n renderEmptyState={props.renderEmptyState}\n className={props.className}\n error={error}\n headerMenuFeatureFlags={headerMenuFeatureFlags}\n editableConfig={editableConfig}\n getRowAttributes={props.getRowAttributes}\n showEditFooter={props.showEditFooter}\n focusedRowId={\n focusedRow == null ? focusedRow : getRowIdFromPrimaryKey<Q>(focusedRow)\n }\n onFocusedRowChanged={onFocusedRowChanged}\n labels={labels}\n />\n );\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAUA,SAASA,eAAe,EAAEC,aAAa,QAAQ,uBAAuB;AACtE,OAAOC,KAAK,IAAIC,WAAW,EAAEC,mBAAmB,EAAEC,OAAO,QAAQ,OAAO;AAExE,SAASC,aAAa,QAAQ,0BAA0B;AACxD,SAASC,gBAAgB,QAAQ,6BAA6B;AAC9D,SAASC,eAAe,QAAQ,4BAA4B;AAC5D,SAASC,mBAAmB,QAAQ,gCAAgC;AACpE,SAASC,gBAAgB,QAAQ,6BAA6B;AAC9D,SAASC,kBAAkB,QAAQ,+BAA+B;AAClE,SAASC,sBAAsB,QAAQ,mCAAmC;AAE1E,SAASC,eAAe,QAAQ,4BAA4B;AAC5D,SAASC,kBAAkB,QAAQ,+BAA+B;AAClE,SAASC,eAAe,QAAQ,4BAA4B;AAE5D,SAASC,SAAS,QAAQ,YAAY;AAEtC,SAASC,wBAAwB,QAAQ,qCAAqC;AAC9E,SAASC,QAAQ,EAAEC,sBAAsB,QAAQ,qBAAqB;AAGtE,MAAMC,WAAe,GAAG,EAAE;AAE1B,OAAO,SAASC,WAAWA,CAOzB;EACAC,UAAU;EACVC,SAAS;EACTC,iBAAiB;EACjBC,MAAM;EACNC,gBAAgB;EAChBC,gBAAgB;EAChBC,QAAQ;EACRC,aAAa;EACbC,OAAO;EACPC,cAAc;EACdC,gBAAgB;EAChBC,sBAAsB;EACtBC,cAAc;EACdC,qBAAqB;EACrBC,mBAAmB;EACnBC,qBAAqB;EACrBC,aAAa,GAAG,MAAM;EACtBC,YAAY;EACZC,aAAa,EAAEC,iBAAiB;EAChCC,yBAAyB;EACzBC,kBAAkB;EAClBC,aAAa;EACbC,cAAc,GAAG,IAAI;EACrBC,mBAAmB,GAAG,IAAI;EAC1BC,oBAAoB,GAAG,IAAI;EAC3BC,kBAAkB,GAAG,IAAI;EACzBC,QAAQ,GAAG,QAAQ;EACnBC,UAAU;EACVC,mBAAmB;EACnBC,QAAQ;EACRC,MAAM;EACN,GAAGC;AACuC,CAAC,EAAsB;EACjE,MAAM;IAAEC,YAAY;IAAEC;EAAqB,CAAC,GAAGhD,eAAe,CAAC;IAC7D0B;EACF,CAAC,CAAC;EAEF,MAAM;IAAEuB,OAAO;IAAEC,eAAe;IAAEC;EAAa,CAAC,GAAG5C,eAAe,CAIhE;IACAe,OAAO;IACPC,cAAc;IACdC;EACF,CAAC,CAAC;EAEF,MAAM;IACJ4B,IAAI;IACJC,SAAS;IACTC,SAAS;IACTC,KAAK;IACLC,UAAU;IACVzC,SAAS,EAAE0C;EACb,CAAC,GAAGtD,kBAAkB,CAA2B;IAC/CuD,qBAAqB,EAAE5C,UAAU;IACjCE,iBAAiB;IACjBC,MAAM;IACNgC,OAAO;IACPlC,SAAS;IACTG,gBAAgB;IAChBC,gBAAgB;IAChBC,QAAQ;IACRC;EACF,CAAC,CAAC;EAEF,MAAM;IAAEsC,OAAO;IAAEC,OAAO,EAAEC;EAAiB,CAAC,GAAG/D,aAAa,CAI1DgB,UAAU,EAAEE,iBAAiB,CAAC;EAEhC,MAAM8C,yBAAyB,GAAGnE,WAAW,CAC1CoE,MAAsC,IAAK;IAC1C,IAAI,CAACpC,qBAAqB,EAAE;IAE5BA,qBAAqB,CAAC;MACpBI,YAAY,EAAEgC,MAAM,CAAChC,YAAY;MACjCiC,WAAW,EAAED,MAAM,CAACC,WAAW;MAC/BjD,SAAS,EAAEN,wBAAwB,CAACgD,kBAAkB,EAAEM,MAAM;IAChE,CAAC,CAAC;EACJ,CAAC,EACD,CAACpC,qBAAqB,EAAE8B,kBAAkB,CAC5C,CAAC;EAED,MAAM;IACJQ,YAAY;IACZjC,aAAa;IACbkC,YAAY;IACZC,WAAW;IACXC,WAAW;IACXC;EACF,CAAC,GAAGhE,eAAe,CAAU;IAC3ByB,aAAa;IACbC,YAAY;IACZC,aAAa,EAAEC,iBAAiB;IAChCN,qBAAqB,EAAEmC,yBAAyB;IAChDV;EACF,CAAC,CAAC;EAEF,MAAMkB,eAAe,GAAGhE,kBAAkB,CAAU;IAClDwB,aAAa;IACbE,aAAa;IACbkC,YAAY;IACZC,WAAW;IACXC;EACF,CAAC,CAAC;EAEF,MAAM;IACJG,gBAAgB;IAChBC,wBAAwB;IACxBC,WAAW;IACXC;EACF,CAAC,GAAGzE,mBAAmB,CAAC;IACtB0E,UAAU,EAAEhB,OAAO;IACnBzB;EACF,CAAC,CAAC;EAEF,MAAM;IAAE0C,aAAa;IAAEC;EAAsB,CAAC,GAAG9E,gBAAgB,CAAC;IAChEiB,iBAAiB;IACjB8D,kBAAkB,EAAET,kBAAkB;IACtC5C;EACF,CAAC,CAAC;EAEF,MAAMkD,UAAU,GAAG9E,OAAO,CAAC,MAAM;IAC/B,OAAOyE,eAAe,GAAG,CAACA,eAAe,EAAE,GAAGX,OAAO,CAAC,GAAGA,OAAO;EAClE,CAAC,EAAE,CAACW,eAAe,EAAEX,OAAO,CAAC,CAAC;EAE9B,MAAMoB,cAGL,GAAG7E,gBAAgB,CAAC;IACnBuC,QAAQ;IACRN,kBAAkB;IAClBC;EACF,CAAC,CAAC;EAEF,MAAM4C,KAAK,GAAGvF,aAAa,CAEzB;IACA2D,IAAI,EAAEA,IAAI,IAAIxC,WAAW;IACzB+C,OAAO,EAAEgB,UAAU;IACnBnF,eAAe,EAAEA,eAAe,CAAC,CAAC;IAClCyF,KAAK,EAAE;MACLV,gBAAgB;MAChBE,WAAW;MACXR,YAAY;MACZhB,OAAO;MACPF,YAAY;MACZ6B;IACF,CAAC;IACD1B,eAAe;IACfF,oBAAoB;IACpB6B,qBAAqB;IACrBL,wBAAwB;IACxBE,mBAAmB;IACnBL,kBAAkB;IAClBa,aAAa,EAAE7C,cAAc;IAC7B8C,gBAAgB,EAAE,UAAU;IAC5BC,qBAAqB,EAAE,KAAK;IAC5BC,aAAa,EAAE,IAAI;IAAE;IACrBC,aAAa,EAAE;MACbC,OAAO,EAAE;IACX,CAAC;IACD7E,QAAQ;IACR8E,IAAI,EAAE;MACJC,UAAU,EAAEV,cAAc,CAACU,UAAU;MACrCC,qBAAqB,EAAEX,cAAc,CAACW,qBAAqB;MAC3DC,wBAAwB,EAAEZ,cAAc,CAACY,wBAAwB;MACjEC,SAAS,EAAEb,cAAc,CAACa,SAAS;MACnCC,YAAY,EAAEd,cAAc,CAACe,aAAa,CAACC,QAAQ;MACnDC,gBAAgB,EAAEjB,cAAc,CAACiB;IACnC;EACF,CAAC,CAAC;EAEF,MAAM;IAAEC;EAAY,CAAC,GAAG7F,sBAAsB,CAA2B;IACvEsD,qBAAqB,EAAE5C,UAAU;IACjCkE,KAAK;IACLhE,iBAAiB;IACjBD,SAAS,EAAE0C,kBAAkB;IAC7BrC,QAAQ;IACRoC,UAAU;IACVlC,OAAO,EAAE6B;EACX,CAAC,CAAC;EAEFvD,mBAAmB,CAACgD,QAAQ,EAAE,OAAO;IAAEqD;EAAY,CAAC,CAAC,EAAE,CAACA,WAAW,CAAC,CAAC;EAErE,MAAMC,uBAAuB,GAAGvG,WAAW,CACzC,CACEwG,GAAkE,EAClEC,IAGC,KACE;IACH,OAAOvE,qBAAqB,GAAGsE,GAAG,EAAEC,IAAI,CAACC,QAAQ,CAAC,CAAC,CAAC;EACtD,CAAC,EACD,CAACxE,qBAAqB,CACxB,CAAC;EAED,MAAMyE,uBAAuB,GAAGzG,OAAO,CACrC,MACE+B,mBAAmB,GACd2E,QAAgB,IACf3E,mBAAmB,CACjB2E,QACF,CAAC,GACHC,SAAS,EACf,CAAC5E,mBAAmB,CACtB,CAAC;EAID,MAAM6E,sBAA8C,GAAG5G,OAAO,CAC5D,OAAO;IACL6G,gBAAgB,EAAErE,cAAc;IAChCsE,gBAAgB,EAAErE,mBAAmB;IACrCsE,cAAc,EAAErE,oBAAoB;IACpCsE,cAAc,EAAErE;EAClB,CAAC,CAAC,EACF,CACEH,cAAc,EACdC,mBAAmB,EACnBC,oBAAoB,EACpBC,kBAAkB,CAEtB,CAAC;EAED,oBACE9C,KAAA,CAAAoH,aAAA,CAACtG,SAAS;IACRwE,KAAK,EAAEA,KAAM;IACb1B,SAAS,EApBUA,SAAS,IAAIO,gBAoBN;IAC1BkD,aAAa,EAAE1D,SAAU;IACzB2D,UAAU,EAAElE,KAAK,CAACkE,UAAW;IAC7BpF,mBAAmB,EAAE0E,uBAAwB;IAC7CW,SAAS,EAAEnE,KAAK,CAACmE,SAAU;IAC3BpF,qBAAqB,EAAEqE,uBAAwB;IAC/CgB,gBAAgB,EAAEpE,KAAK,CAACoE,gBAAiB;IACzCC,SAAS,EAAErE,KAAK,CAACqE,SAAU;IAC3B5D,KAAK,EAAEA,KAAM;IACbkD,sBAAsB,EAAEA,sBAAuB;IAC/C1B,cAAc,EAAEA,cAAe;IAC/BqC,gBAAgB,EAAEtE,KAAK,CAACsE,gBAAiB;IACzCC,cAAc,EAAEvE,KAAK,CAACuE,cAAe;IACrCC,YAAY,EACV5E,UAAU,IAAI,IAAI,GAAGA,UAAU,GAAG/B,sBAAsB,CAAI+B,UAAU,CACvE;IACDC,mBAAmB,EAAEA,mBAAoB;IACzCE,MAAM,EAAEA;EAAO,CAChB,CAAC;AAEN","ignoreList":[]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ObjectTableApi.js","names":[],"sources":["ObjectTableApi.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n CompileTimeMetadata,\n DerivedProperty,\n ObjectOrInterfaceDefinition,\n ObjectSet,\n Osdk,\n PrimaryKeyType,\n PropertyKeys,\n QueryDefinition,\n SimplePropertyDef,\n WhereClause,\n} from \"@osdk/api\";\nimport type { QueryParameterType } from \"@osdk/client/observable\";\nimport type * as React from \"react\";\n\nimport type { CellEditInfo, EditFieldConfig } from \"./utils/types.js\";\n\nexport type { EditFieldConfig } from \"./utils/types.js\";\n\nexport type ColumnDefinition<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> =\n | EditableColumnDefinition<Q, RDPs, FunctionColumns>\n | ReadonlyColumnDefinition<Q, RDPs, FunctionColumns>;\n\ninterface SharedColumnDefinition<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> {\n /**\n * Defines what the column shows:\n * an object/interface property, a linked object property (derived property), a function\n * column, or a custom column — and carries that locator's configuration.\n */\n locator: ColumnDefinitionLocator<Q, RDPs, FunctionColumns>;\n\n /**\n * @default true\n */\n isVisible?: boolean;\n\n /**\n * @default none\n */\n pinned?: \"left\" | \"right\" | \"none\";\n width?: number;\n minWidth?: number;\n maxWidth?: number;\n resizable?: boolean;\n orderable?: boolean;\n\n /**\n * Custom renderer for the cell value.\n *\n * Interaction with `editable` columns:\n * - When `editMode: \"manual\"` (default), `renderCell` is used while the\n * table is read-only (Edit Table button visible) and the editable cell\n * takes over once the user enters edit mode.\n * - When `editMode: \"always\"`, the editable cell always wins on editable\n * columns and `renderCell` is ignored — `editMode: \"always\"` opts the\n * column into a permanently-editable surface, leaving no read-only\n * state for `renderCell` to render. Use `editMode: \"manual\"` if you\n * need a custom display alongside editing.\n */\n renderCell?: (\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n locator: ColumnDefinitionLocator<Q, RDPs, FunctionColumns>\n ) => React.ReactNode;\n\n /**\n * If provided, this will be used in the column header.\n * If both columnName and renderHeader are provided, renderHeader will take precedence in the table header.\n * columnName will still be used in other parts where the column name is displayed.\n *\n * If not provided,\n * for a property column, the property displayName will be used\n * for other columns, the id will be used.\n */\n columnName?: string;\n\n /**\n * If provided, this will be used to render the header component.\n * When both columnName and renderHeader are provided, renderHeader will take precedence in the table header.\n */\n renderHeader?: () => React.ReactNode;\n}\n\ninterface EditableColumnDefinition<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> extends SharedColumnDefinition<Q, RDPs, FunctionColumns> {\n /**\n * `editable` can be a boolean or a predicate that receives the row's object\n * and returns whether the cell is editable\n */\n editable:\n | true\n | ((\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n ) => boolean);\n\n /**\n * Configuration for the cell editor component.\n *\n * When provided, the column uses the specified field component\n * (e.g. dropdown) instead of the default auto-detected text/number input.\n *\n * `getFieldComponentProps` receives the row's object and a map of any\n * pending edits for that row (keyed by column id), and returns the props to\n * pass to the field component. Editor configuration can depend on the\n * current row or on other in-progress edits within the row.\n */\n editFieldConfig?: EditFieldConfig<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n >;\n\n /**\n * Additional function to validate the cell value during edit.\n *\n * @param value the current cell value\n * @returns a promise that resolves to an error message string if validation fails, or undefined if validation succeeds\n */\n validateEdit?: (value: unknown) => Promise<string | undefined>;\n}\n\n/**\n * Column definition for a read-only column (default).\n * `editFieldConfig` and `validateEdit` are not available.\n */\ninterface ReadonlyColumnDefinition<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> extends SharedColumnDefinition<Q, RDPs, FunctionColumns> {\n editable?: false;\n}\n\nexport type ExtractQueryParameters<Q extends QueryDefinition> =\n CompileTimeMetadata<Q>[\"parameters\"] extends Record<string, never>\n ? undefined\n : QueryParameterType<CompileTimeMetadata<Q>[\"parameters\"]>;\n\nexport interface PropertyColumnLocator<Q extends ObjectOrInterfaceDefinition> {\n type: \"property\";\n id: PropertyKeys<Q>;\n}\n\n/**\n * Concrete function column locator for a single key K.\n * Correlates the id, queryDefinition, and getFunctionParams types.\n */\ninterface FunctionColumnLocatorForKey<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef>,\n FunctionColumns extends Record<string, QueryDefinition<{}>>,\n K extends keyof FunctionColumns,\n> {\n /**\n * This is equivalent to workshop's function-backed columns.\n * The function needs to meet the specifications stated in https://www.palantir.com/docs/foundry/workshop/widgets-object-table/#function-backed-columns\n */\n type: \"function\";\n id: K;\n queryDefinition: FunctionColumns[K];\n\n /**\n * The function will be called with the current object set to get the input parameters for the function query.\n * @param objectSet - The current object set.\n * @returns - The function's input parameters including the object set.\n */\n getFunctionParams: (\n objectSet: ObjectSet<Q, RDPs>\n ) => ExtractQueryParameters<FunctionColumns[K]>;\n\n /**\n * Function to generate keys for looking up results in the FunctionsMap.\n * @param object - The object instance\n * @returns - The key to use for looking up this object's result in the FunctionsMap\n */\n getKey: (\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n ) => string;\n\n /**\n * Function to extract the cell value from the raw cell data returned by the function.\n * This is useful when functions return custom types with multiple properties.\n * @param cellData - The raw data returned by the function for this object\n * @returns - The value to display in the cell\n */\n getValue?: (cellData?: unknown) => unknown;\n\n /**\n * Minimum time between re-fetches of the same function with the same parameters, in milliseconds.\n * Defaults to 5 minutes as it is expensive to fetch function columns for a large object set\n * and they are expected to be relatively static in the context of an object table\n *\n * @default 300_000 (5 minutes)\n */\n dedupeIntervalMs?: number;\n\n /**\n * Object type apiNames the function reads but doesn't take as a parameter (e.g.\n * linked object types the function traverses internally). The column auto-revalidates\n * when an action edits an object of any of these types. Param-derived types are\n * tracked automatically and don't need to be listed here.\n */\n dependsOn?: string[];\n}\n\n/**\n * Distributes over each key in FunctionColumns so that id, queryDefinition,\n * and getFunctionParams are correlated per key.\n */\nexport type FunctionColumnLocator<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> = keyof FunctionColumns extends infer K\n ? K extends keyof FunctionColumns\n ? FunctionColumnLocatorForKey<Q, RDPs, FunctionColumns, K>\n : never\n : never;\n\nexport interface RdpColumnLocator<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n> {\n type: \"rdp\";\n id: keyof RDPs;\n creator: DerivedProperty.Creator<Q, RDPs[keyof RDPs]>;\n}\n\nexport interface CustomColumnLocator {\n type: \"custom\";\n id: string;\n}\n\nexport type ColumnDefinitionLocator<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> =\n | PropertyColumnLocator<Q>\n | FunctionColumnLocator<Q, RDPs, FunctionColumns>\n | RdpColumnLocator<Q, RDPs>\n | CustomColumnLocator;\n\nexport interface ObjectTableProps<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> {\n /**\n * The object or interface type of the object\n * If objectSet is not provided, objects will be fetched based on this type.\n */\n objectType: Q;\n\n /**\n * The set of objects to show in the table.\n * If provided, the table fetches through this object set instead of fetching based on\n * objectType. Supported for both object and interface types.\n *\n * For an interface object set, rows expose the interface's declared properties;\n * the underlying concrete object's non-interface properties are not loaded.\n * Use objectType-based fetching if you need those.\n */\n objectSet?: ObjectSet<Q>;\n\n objectSetOptions?: ObjectSetOptions<Q>;\n\n /**\n * Minimum time between fetch requests in milliseconds.\n * Increasing this value reduces redundant network calls when the same data\n * is requested multiple times in quick succession.\n *\n * @default 60_000 1 minute\n */\n dedupeIntervalMs?: number;\n\n /**\n * Enable streaming updates via websocket subscription.\n * When true, the table will automatically update when matching\n * objects are added, updated, or removed in Foundry.\n *\n * Limitations: `streamUpdates` cannot be used together with `pivotTo` or\n * `withProperties`. The server does not support websocket subscriptions\n * for link-traversal or derived-property queries. Those queries still\n * fetch data normally but won't receive real-time updates.\n *\n * @default false\n */\n streamUpdates?: boolean;\n\n /**\n * Number of objects to fetch per page.\n *\n * @default 50\n */\n pageSize?: number;\n\n /**\n * Ordered list of column definitions to show in the table\n *\n * If not provided, all of the properties of the object type will be shown in default order.\n */\n columnDefinitions?: Array<ColumnDefinition<Q, RDPs, FunctionColumns>>;\n\n /**\n * The current where clause to filter the objects in the table.\n * If provided, the filter is controlled.\n */\n filter?: WhereClause<Q, RDPs>;\n\n /**\n * Whether the table is sortable by the user.\n *\n * @default true\n */\n enableOrdering?: boolean;\n\n /**\n * Whether columns can be pinned by the user.\n *\n * @default true\n */\n enableColumnPinning?: boolean;\n\n /**\n * Whether columns can be resized by the user.\n *\n * @default true\n */\n enableColumnResizing?: boolean;\n\n /**\n * Whether the column configuration dialog for column visibility and ordering is available to the user.\n *\n * @default true\n */\n enableColumnConfig?: boolean;\n\n /**\n * Controls the edit mode behavior of the table.\n * - \"always\": Editable cells are immediately in edit mode on row clicked.\n * - \"manual\": User can toggle edit mode on/off via the Edit Table button.\n *\n * @default \"manual\"\n */\n editMode?: \"always\" | \"manual\";\n\n /**\n * Whether to render the bottom edit footer that hosts the\n * \"Edit Table\" / \"Cancel\" / \"Submit Edits\" buttons and the edit-state\n * indicators (modification count, validation errors).\n *\n * @default true whenever the table has at least one column declared\n * editable (i.e. any column with `editable: true` or `editable: (object) => boolean`).\n * When `false`, the \"Edit Table\" and \"Submit Edits\" buttons will not be shown.\n */\n showEditFooter?: boolean;\n\n /**\n * The default order by clause to sort the objects in the table.\n * If provided without orderBy prop, the sorting is uncontrolled.\n * If both orderBy and defaultOrderBy are provided, orderBy takes precedence.\n */\n defaultOrderBy?: Array<{\n property: PropertyKeys<Q> | keyof RDPs;\n direction: \"asc\" | \"desc\";\n }>;\n\n /**\n * The current order by clause to sort the objects in the table.\n * If provided, the sorting is controlled.\n * If both orderBy and defaultOrderBy are provided, orderBy takes precedence.\n */\n orderBy?: Array<{\n property: PropertyKeys<Q> | keyof RDPs;\n direction: \"asc\" | \"desc\";\n }>;\n\n /**\n * Called when the order by clause is changed.\n * Required when sorting is controlled.\n *\n * @param newOrderBy The new order by clause\n */\n onOrderByChanged?: (\n newOrderBy: Array<{\n property: PropertyKeys<Q> | keyof RDPs;\n direction: \"asc\" | \"desc\";\n }>\n ) => void;\n\n /**\n * Called after the value of a cell is edited and committed by the user.\n *\n * @param info An object containing details about the cell that was edited,\n * including the rowId, columnId, new and old values, and the row data before the edit\n */\n onCellValueChanged?: (\n info: CellEditInfo<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n unknown\n >\n ) => void;\n\n /**\n * If provided, the \"Submit Edits\" button will be shown in the edit footer.\n *\n * @param edits an array of edit info containing details about the edited cells\n * including the rowId, columnId, new and old values, and the row data before the edit\n * @return a promise that resolves to true if the edits were successfully submitted\n */\n onSubmitEdits?: (\n edits: CellEditInfo<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n unknown\n >[]\n ) => Promise<boolean>;\n\n /**\n * Called when the column visibility or ordering changed.\n *\n * If provided, the table will allow the user to show/hide columns.\n *\n * @param newStates The columns sorted in their display order in the table and their visibility state.\n */\n onColumnVisibilityChanged?: (\n newStates: Array<{\n columnId: PropertyKeys<Q> | keyof RDPs | keyof FunctionColumns;\n isVisible: boolean;\n }>\n ) => void;\n\n /**\n * Called when the pinned columns change.\n *\n * If provided, the table will allow the user to pin/unpin columns.\n *\n * @param newStates The new list of column pin states\n */\n onColumnsPinnedChanged?: (\n newStates: Array<{\n columnId: PropertyKeys<Q> | keyof RDPs | keyof FunctionColumns;\n pinned: \"left\" | \"right\" | \"none\";\n }>\n ) => void;\n\n /**\n * Called when a column is resized.\n *\n * @param columnId The ID of the resized column\n * @param newWidth The new width of the column. When newWidth = null, the column size is reset.\n */\n onColumnResize?: (\n columnId: PropertyKeys<Q> | keyof RDPs | keyof FunctionColumns,\n newWidth: number | null\n ) => void;\n\n /**\n * Called when a row is clicked.\n *\n * @param object The object representing the clicked row\n */\n onRowClick?: (\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n ) => void;\n\n /**\n * The primary key of the row to render as visually focused (the\n * \"last interacted\" row). When provided, focus state is controlled by\n * the caller.\n *\n * Stored as a primary key rather than a full object so the focus does\n * not go stale when the underlying row data changes.\n *\n * Pass `null` to render no row as focused.\n */\n focusedRow?: PrimaryKeyType<Q> | null;\n\n /**\n * Called when the focused row changes — fires in both controlled and\n * uncontrolled modes so callers can observe focus without taking it\n * over.\n *\n * @param row The newly-focused row object, or `null` if focus was\n * cleared\n */\n onFocusedRowChanged?: (\n row: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs> | null\n ) => void;\n\n /**\n * Called when a column header is clicked.\n *\n * The columnId matches the `locator.id` configured on the column definition.\n * The dropdown menu trigger is excluded — clicking the chevron opens the\n * header menu instead of firing this callback.\n *\n * @param columnId The id of the clicked column\n */\n onColumnHeaderClick?: (\n columnId: PropertyKeys<Q> | keyof RDPs | keyof FunctionColumns\n ) => void;\n\n /**\n * Selection mode for the table rows.\n *\n * If multiple, a checkbox will be shown for each row to allow selecting multiple rows\n * as well as a top-level checkbox in the header to select all rows.\n *\n * @default \"none\"\n */\n selectionMode?: \"single\" | \"multiple\" | \"none\";\n\n /**\n * The currently selected rows in the table.\n * If provided, the row selection is controlled.\n */\n selectedRows?: PrimaryKeyType<Q>[];\n\n /**\n * Indicates whether all rows are selected in controlled mode.\n * When true, the table will show all rows as selected regardless of the selectedRows array.\n */\n isAllSelected?: boolean;\n\n /**\n * Called when the row selection changes, with a {@link RowSelectionChange}\n * payload describing the new state.\n *\n * @param change The new selection state. See {@link RowSelectionChange}.\n */\n onRowSelectionChanged?: (change: RowSelectionChange<Q, RDPs>) => void;\n /**\n * If provided, will render this context menu when right clicking on a cell\n */\n renderCellContextMenu?: (\n row: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n cellValue: unknown\n ) => React.ReactNode;\n\n /**\n * Render override for the empty state. Called when the table has no\n * rows and no error. When omitted, a default \"No Data\" indicator is\n * rendered.\n */\n renderEmptyState?: () => React.ReactNode;\n\n /**\n * The height of each row in pixels.\n *\n * @default 40\n */\n rowHeight?: number;\n\n /**\n * Returns extra HTML attributes (typically `data-*`) to apply to each\n * row element. Use this to drive conditional row styling\n */\n getRowAttributes?: (\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n ) => Record<string, string | undefined>;\n\n /**\n * Imperative handle for programmatic table actions. Pass a ref\n * (`useRef<ObjectTableHandle<Q, RDPs>>(null)`) to call\n * {@link ObjectTableHandle} methods such as\n * {@link ObjectTableHandle.getSnapshot}.\n */\n tableRef?: React.Ref<ObjectTableHandle<Q, RDPs>>;\n\n className?: string;\n}\n\n/**\n * Imperative handle exposing programmatic actions on an {@link ObjectTable}.\n * Obtain it by passing {@link ObjectTableProps.tableRef}.\n */\nexport interface ObjectTableHandle<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n> {\n /**\n * Loads every row matching the object set and returns a format-agnostic\n * snapshot of the table's columns, row values, and total count. The caller\n * is responsible for turning the snapshot into a downloadable artifact\n * (CSV, Excel, JSON, clipboard, …).\n *\n * Property, derived-property, and function-backed columns are included.\n * Function-backed cells are fetched per page during snapshot collection;\n * when a page's fetch fails, `row.getValue(columnId)` returns the thrown\n * `Error` instance for the affected cells while the rest of the snapshot\n * resolves normally.\n * Columns defined with `locator.type === \"custom\"` are omitted because\n * they have no underlying value to export.\n *\n * The returned promise rejects up front when the object set's `totalCount`\n * exceeds `rowLimit`. When `totalCount` is unavailable, it instead rejects\n * mid-load once more than `rowLimit` rows have been pulled, so an unknown\n * count can't drain an unbounded set into the client. Otherwise every\n * matching row is loaded.\n *\n * @param options See {@link ObjectTableSnapshotOptions}.\n */\n getSnapshot: (\n options?: ObjectTableSnapshotOptions\n ) => Promise<ObjectTableSnapshot<Q, RDPs>>;\n}\n\n/**\n * Options for {@link ObjectTableHandle[\"getSnapshot\"]}.\n */\nexport interface ObjectTableSnapshotOptions {\n /**\n * Upper bound on how many rows the snapshot may contain. When the object\n * set's total row count exceeds this value, `getSnapshot` rejects;\n * otherwise every matching row is loaded.\n *\n * @default 10_000\n */\n rowLimit?: number;\n}\n\n/**\n * A point-in-time capture of an {@link ObjectTable}'s columns and row values,\n * returned by {@link ObjectTableHandle.getSnapshot}.\n */\nexport interface ObjectTableSnapshot<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n> {\n columns: ObjectTableDataColumn[];\n rows: ObjectTableDataRow<Q, RDPs>[];\n /**\n * Total number of objects matching the underlying object set, as reported\n * by the API. `undefined` when the API did not provide a count. Encoded as\n * a string to match the underlying list-payload representation.\n */\n totalCount: string | undefined;\n}\n\n/**\n * A single column in an {@link ObjectTableSnapshot}.\n */\nexport interface ObjectTableDataColumn {\n /** Column id, matching the `locator.id` of the column definition. */\n id: string;\n /** Display name shown in the table header. */\n name: string;\n}\n\n/**\n * A single row in an {@link ObjectTableSnapshot}.\n */\nexport interface ObjectTableDataRow<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n> {\n /** Row id (the underlying object's `$primaryKey` rendered as a string). */\n id: string;\n /** The underlying loaded object. */\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>;\n /**\n * Returns the cell value for a given column id, or `undefined` when the\n * column is not part of the snapshot. Function-backed cells whose query\n * failed surface the thrown `Error` instance as their value.\n */\n getValue: (columnId: string) => unknown;\n}\n\n/**\n * Payload for {@link ObjectTableProps.onRowSelectionChanged}. Consolidates\n * the loaded row instances, the `isSelectAll` semantic intent, and an\n * `ObjectSet` covering the selection.\n */\nexport interface RowSelectionChange<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n> {\n /**\n * Loaded row instances currently selected. When `isSelectAll` is true,\n * this reflects only the rows currently in the table — pages not yet\n * fetched are absent. Use `objectSet` for the cross-page view, and\n * `selectedRows.map(r => r.$primaryKey)` if you need the primary keys.\n */\n selectedRows: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>[];\n\n /**\n * True when the user invoked \"select all\" (header checkbox) or when\n * controlled mode supplies `isAllSelected={true}`. Distinct from \"every\n * loaded row happens to be selected\" — that condition is reflected by\n * `selectedRows.length` matching the visible row count but does not set\n * this flag.\n */\n isSelectAll: boolean;\n\n /**\n * An `ObjectSet` representing the selection.\n *\n * - \"Select all\" → the underlying `ObjectSet` (`objectSet` prop if\n * provided, otherwise derived from `objectType` via `client(...)`).\n * This includes rows not yet loaded into the table.\n * - Partial selection → the underlying `ObjectSet` narrowed to\n * `{ $primaryKey: { $in: selectedRows.map(r => r.$primaryKey) } }`.\n * - \"Deselect all\" → an empty `ObjectSet` (`$in: []`).\n *\n * Works for both object and interface types, since the `$primaryKey`\n * special property does not require resolving the underlying primary key\n * property name. `undefined` only when there is no underlying `ObjectSet`\n * to derive from.\n */\n objectSet: ObjectSet<Q, RDPs> | undefined;\n}\n\nexport interface ObjectSetOptions<Q extends ObjectOrInterfaceDefinition> {\n /**\n * Object sets to union with\n */\n union?: ObjectSet<Q>[];\n\n /**\n * Object sets to intersect with\n */\n intersect?: ObjectSet<Q>[];\n\n /**\n * Object sets to subtract from\n */\n subtract?: ObjectSet<Q>[];\n}\n"],"mappings":"","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"ObjectTableApi.js","names":[],"sources":["ObjectTableApi.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n CompileTimeMetadata,\n DerivedProperty,\n ObjectOrInterfaceDefinition,\n ObjectSet,\n Osdk,\n PrimaryKeyType,\n PropertyKeys,\n QueryDefinition,\n SimplePropertyDef,\n WhereClause,\n} from \"@osdk/api\";\nimport type { QueryParameterType } from \"@osdk/client/observable\";\nimport type * as React from \"react\";\n\nimport type { ObjectTableLabels } from \"./ObjectTableLabels.js\";\nimport type { CellEditInfo, EditFieldConfig } from \"./utils/types.js\";\n\nexport type { EditFieldConfig } from \"./utils/types.js\";\n\nexport type ColumnDefinition<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> =\n | EditableColumnDefinition<Q, RDPs, FunctionColumns>\n | ReadonlyColumnDefinition<Q, RDPs, FunctionColumns>;\n\ninterface SharedColumnDefinition<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> {\n /**\n * Defines what the column shows:\n * an object/interface property, a linked object property (derived property), a function\n * column, or a custom column — and carries that locator's configuration.\n */\n locator: ColumnDefinitionLocator<Q, RDPs, FunctionColumns>;\n\n /**\n * @default true\n */\n isVisible?: boolean;\n\n /**\n * @default none\n */\n pinned?: \"left\" | \"right\" | \"none\";\n width?: number;\n minWidth?: number;\n maxWidth?: number;\n resizable?: boolean;\n orderable?: boolean;\n\n /**\n * Custom renderer for the cell value.\n *\n * Interaction with `editable` columns:\n * - When `editMode: \"manual\"` (default), `renderCell` is used while the\n * table is read-only (Edit Table button visible) and the editable cell\n * takes over once the user enters edit mode.\n * - When `editMode: \"always\"`, the editable cell always wins on editable\n * columns and `renderCell` is ignored — `editMode: \"always\"` opts the\n * column into a permanently-editable surface, leaving no read-only\n * state for `renderCell` to render. Use `editMode: \"manual\"` if you\n * need a custom display alongside editing.\n */\n renderCell?: (\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n locator: ColumnDefinitionLocator<Q, RDPs, FunctionColumns>\n ) => React.ReactNode;\n\n /**\n * If provided, this will be used in the column header.\n * If both columnName and renderHeader are provided, renderHeader will take precedence in the table header.\n * columnName will still be used in other parts where the column name is displayed.\n *\n * If not provided,\n * for a property column, the property displayName will be used\n * for other columns, the id will be used.\n */\n columnName?: string;\n\n /**\n * If provided, this will be used to render the header component.\n * When both columnName and renderHeader are provided, renderHeader will take precedence in the table header.\n */\n renderHeader?: () => React.ReactNode;\n}\n\ninterface EditableColumnDefinition<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> extends SharedColumnDefinition<Q, RDPs, FunctionColumns> {\n /**\n * `editable` can be a boolean or a predicate that receives the row's object\n * and returns whether the cell is editable\n */\n editable:\n | true\n | ((\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n ) => boolean);\n\n /**\n * Configuration for the cell editor component.\n *\n * When provided, the column uses the specified field component\n * (e.g. dropdown) instead of the default auto-detected text/number input.\n *\n * `getFieldComponentProps` receives the row's object and a map of any\n * pending edits for that row (keyed by column id), and returns the props to\n * pass to the field component. Editor configuration can depend on the\n * current row or on other in-progress edits within the row.\n */\n editFieldConfig?: EditFieldConfig<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n >;\n\n /**\n * Additional function to validate the cell value during edit.\n *\n * @param value the current cell value\n * @returns a promise that resolves to an error message string if validation fails, or undefined if validation succeeds\n */\n validateEdit?: (value: unknown) => Promise<string | undefined>;\n}\n\n/**\n * Column definition for a read-only column (default).\n * `editFieldConfig` and `validateEdit` are not available.\n */\ninterface ReadonlyColumnDefinition<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> extends SharedColumnDefinition<Q, RDPs, FunctionColumns> {\n editable?: false;\n}\n\nexport type ExtractQueryParameters<Q extends QueryDefinition> =\n CompileTimeMetadata<Q>[\"parameters\"] extends Record<string, never>\n ? undefined\n : QueryParameterType<CompileTimeMetadata<Q>[\"parameters\"]>;\n\nexport interface PropertyColumnLocator<Q extends ObjectOrInterfaceDefinition> {\n type: \"property\";\n id: PropertyKeys<Q>;\n}\n\n/**\n * Concrete function column locator for a single key K.\n * Correlates the id, queryDefinition, and getFunctionParams types.\n */\ninterface FunctionColumnLocatorForKey<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef>,\n FunctionColumns extends Record<string, QueryDefinition<{}>>,\n K extends keyof FunctionColumns,\n> {\n /**\n * This is equivalent to workshop's function-backed columns.\n * The function needs to meet the specifications stated in https://www.palantir.com/docs/foundry/workshop/widgets-object-table/#function-backed-columns\n */\n type: \"function\";\n id: K;\n queryDefinition: FunctionColumns[K];\n\n /**\n * The function will be called with the current object set to get the input parameters for the function query.\n * @param objectSet - The current object set.\n * @returns - The function's input parameters including the object set.\n */\n getFunctionParams: (\n objectSet: ObjectSet<Q, RDPs>\n ) => ExtractQueryParameters<FunctionColumns[K]>;\n\n /**\n * Function to generate keys for looking up results in the FunctionsMap.\n * @param object - The object instance\n * @returns - The key to use for looking up this object's result in the FunctionsMap\n */\n getKey: (\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n ) => string;\n\n /**\n * Function to extract the cell value from the raw cell data returned by the function.\n * This is useful when functions return custom types with multiple properties.\n * @param cellData - The raw data returned by the function for this object\n * @returns - The value to display in the cell\n */\n getValue?: (cellData?: unknown) => unknown;\n\n /**\n * Minimum time between re-fetches of the same function with the same parameters, in milliseconds.\n * Defaults to 5 minutes as it is expensive to fetch function columns for a large object set\n * and they are expected to be relatively static in the context of an object table\n *\n * @default 300_000 (5 minutes)\n */\n dedupeIntervalMs?: number;\n\n /**\n * Object type apiNames the function reads but doesn't take as a parameter (e.g.\n * linked object types the function traverses internally). The column auto-revalidates\n * when an action edits an object of any of these types. Param-derived types are\n * tracked automatically and don't need to be listed here.\n */\n dependsOn?: string[];\n}\n\n/**\n * Distributes over each key in FunctionColumns so that id, queryDefinition,\n * and getFunctionParams are correlated per key.\n */\nexport type FunctionColumnLocator<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> = keyof FunctionColumns extends infer K\n ? K extends keyof FunctionColumns\n ? FunctionColumnLocatorForKey<Q, RDPs, FunctionColumns, K>\n : never\n : never;\n\nexport interface RdpColumnLocator<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n> {\n type: \"rdp\";\n id: keyof RDPs;\n creator: DerivedProperty.Creator<Q, RDPs[keyof RDPs]>;\n}\n\nexport interface CustomColumnLocator {\n type: \"custom\";\n id: string;\n}\n\nexport type ColumnDefinitionLocator<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> =\n | PropertyColumnLocator<Q>\n | FunctionColumnLocator<Q, RDPs, FunctionColumns>\n | RdpColumnLocator<Q, RDPs>\n | CustomColumnLocator;\n\nexport interface ObjectTableProps<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n FunctionColumns extends Record<string, QueryDefinition<{}>> = Record<\n string,\n never\n >,\n> {\n /**\n * The object or interface type of the object\n * If objectSet is not provided, objects will be fetched based on this type.\n */\n objectType: Q;\n\n /**\n * The set of objects to show in the table.\n * If provided, the table fetches through this object set instead of fetching based on\n * objectType. Supported for both object and interface types.\n *\n * For an interface object set, rows expose the interface's declared properties;\n * the underlying concrete object's non-interface properties are not loaded.\n * Use objectType-based fetching if you need those.\n */\n objectSet?: ObjectSet<Q>;\n\n objectSetOptions?: ObjectSetOptions<Q>;\n\n /**\n * Minimum time between fetch requests in milliseconds.\n * Increasing this value reduces redundant network calls when the same data\n * is requested multiple times in quick succession.\n *\n * @default 60_000 1 minute\n */\n dedupeIntervalMs?: number;\n\n /**\n * Enable streaming updates via websocket subscription.\n * When true, the table will automatically update when matching\n * objects are added, updated, or removed in Foundry.\n *\n * Limitations: `streamUpdates` cannot be used together with `pivotTo` or\n * `withProperties`. The server does not support websocket subscriptions\n * for link-traversal or derived-property queries. Those queries still\n * fetch data normally but won't receive real-time updates.\n *\n * @default false\n */\n streamUpdates?: boolean;\n\n /**\n * Number of objects to fetch per page.\n *\n * @default 50\n */\n pageSize?: number;\n\n /**\n * Ordered list of column definitions to show in the table\n *\n * If not provided, all of the properties of the object type will be shown in default order.\n */\n columnDefinitions?: Array<ColumnDefinition<Q, RDPs, FunctionColumns>>;\n\n /**\n * The current where clause to filter the objects in the table.\n * If provided, the filter is controlled.\n */\n filter?: WhereClause<Q, RDPs>;\n\n /**\n * Whether the table is sortable by the user.\n *\n * @default true\n */\n enableOrdering?: boolean;\n\n /**\n * Whether columns can be pinned by the user.\n *\n * @default true\n */\n enableColumnPinning?: boolean;\n\n /**\n * Whether columns can be resized by the user.\n *\n * @default true\n */\n enableColumnResizing?: boolean;\n\n /**\n * Whether the column configuration dialog for column visibility and ordering is available to the user.\n *\n * @default true\n */\n enableColumnConfig?: boolean;\n\n /**\n * Controls the edit mode behavior of the table.\n * - \"always\": Editable cells are immediately in edit mode on row clicked.\n * - \"manual\": User can toggle edit mode on/off via the Edit Table button.\n *\n * @default \"manual\"\n */\n editMode?: \"always\" | \"manual\";\n\n /**\n * Whether to render the bottom edit footer that hosts the\n * \"Edit Table\" / \"Cancel\" / \"Submit Edits\" buttons and the edit-state\n * indicators (modification count, validation errors).\n *\n * @default true whenever the table has at least one column declared\n * editable (i.e. any column with `editable: true` or `editable: (object) => boolean`).\n * When `false`, the \"Edit Table\" and \"Submit Edits\" buttons will not be shown.\n */\n showEditFooter?: boolean;\n\n /**\n * The default order by clause to sort the objects in the table.\n * If provided without orderBy prop, the sorting is uncontrolled.\n * If both orderBy and defaultOrderBy are provided, orderBy takes precedence.\n */\n defaultOrderBy?: Array<{\n property: PropertyKeys<Q> | keyof RDPs;\n direction: \"asc\" | \"desc\";\n }>;\n\n /**\n * The current order by clause to sort the objects in the table.\n * If provided, the sorting is controlled.\n * If both orderBy and defaultOrderBy are provided, orderBy takes precedence.\n */\n orderBy?: Array<{\n property: PropertyKeys<Q> | keyof RDPs;\n direction: \"asc\" | \"desc\";\n }>;\n\n /**\n * Called when the order by clause is changed.\n * Required when sorting is controlled.\n *\n * @param newOrderBy The new order by clause\n */\n onOrderByChanged?: (\n newOrderBy: Array<{\n property: PropertyKeys<Q> | keyof RDPs;\n direction: \"asc\" | \"desc\";\n }>\n ) => void;\n\n /**\n * Called after the value of a cell is edited and committed by the user.\n *\n * @param info An object containing details about the cell that was edited,\n * including the rowId, columnId, new and old values, and the row data before the edit\n */\n onCellValueChanged?: (\n info: CellEditInfo<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n unknown\n >\n ) => void;\n\n /**\n * If provided, the \"Submit Edits\" button will be shown in the edit footer.\n *\n * @param edits an array of edit info containing details about the edited cells\n * including the rowId, columnId, new and old values, and the row data before the edit\n * @return a promise that resolves to true if the edits were successfully submitted\n */\n onSubmitEdits?: (\n edits: CellEditInfo<\n Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n unknown\n >[]\n ) => Promise<boolean>;\n\n /**\n * Called when the column visibility or ordering changed.\n *\n * If provided, the table will allow the user to show/hide columns.\n *\n * @param newStates The columns sorted in their display order in the table and their visibility state.\n */\n onColumnVisibilityChanged?: (\n newStates: Array<{\n columnId: PropertyKeys<Q> | keyof RDPs | keyof FunctionColumns;\n isVisible: boolean;\n }>\n ) => void;\n\n /**\n * Called when the pinned columns change.\n *\n * If provided, the table will allow the user to pin/unpin columns.\n *\n * @param newStates The new list of column pin states\n */\n onColumnsPinnedChanged?: (\n newStates: Array<{\n columnId: PropertyKeys<Q> | keyof RDPs | keyof FunctionColumns;\n pinned: \"left\" | \"right\" | \"none\";\n }>\n ) => void;\n\n /**\n * Called when a column is resized.\n *\n * @param columnId The ID of the resized column\n * @param newWidth The new width of the column. When newWidth = null, the column size is reset.\n */\n onColumnResize?: (\n columnId: PropertyKeys<Q> | keyof RDPs | keyof FunctionColumns,\n newWidth: number | null\n ) => void;\n\n /**\n * Called when a row is clicked.\n *\n * @param object The object representing the clicked row\n */\n onRowClick?: (\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n ) => void;\n\n /**\n * The primary key of the row to render as visually focused (the\n * \"last interacted\" row). When provided, focus state is controlled by\n * the caller.\n *\n * Stored as a primary key rather than a full object so the focus does\n * not go stale when the underlying row data changes.\n *\n * Pass `null` to render no row as focused.\n */\n focusedRow?: PrimaryKeyType<Q> | null;\n\n /**\n * Called when the focused row changes — fires in both controlled and\n * uncontrolled modes so callers can observe focus without taking it\n * over.\n *\n * @param row The newly-focused row object, or `null` if focus was\n * cleared\n */\n onFocusedRowChanged?: (\n row: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs> | null\n ) => void;\n\n /**\n * Called when a column header is clicked.\n *\n * The columnId matches the `locator.id` configured on the column definition.\n * The dropdown menu trigger is excluded — clicking the chevron opens the\n * header menu instead of firing this callback.\n *\n * @param columnId The id of the clicked column\n */\n onColumnHeaderClick?: (\n columnId: PropertyKeys<Q> | keyof RDPs | keyof FunctionColumns\n ) => void;\n\n /**\n * Selection mode for the table rows.\n *\n * If multiple, a checkbox will be shown for each row to allow selecting multiple rows\n * as well as a top-level checkbox in the header to select all rows.\n *\n * @default \"none\"\n */\n selectionMode?: \"single\" | \"multiple\" | \"none\";\n\n /**\n * The currently selected rows in the table.\n * If provided, the row selection is controlled.\n */\n selectedRows?: PrimaryKeyType<Q>[];\n\n /**\n * Indicates whether all rows are selected in controlled mode.\n * When true, the table will show all rows as selected regardless of the selectedRows array.\n */\n isAllSelected?: boolean;\n\n /**\n * Called when the row selection changes, with a {@link RowSelectionChange}\n * payload describing the new state.\n *\n * @param change The new selection state. See {@link RowSelectionChange}.\n */\n onRowSelectionChanged?: (change: RowSelectionChange<Q, RDPs>) => void;\n /**\n * If provided, will render this context menu when right clicking on a cell\n */\n renderCellContextMenu?: (\n row: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>,\n cellValue: unknown\n ) => React.ReactNode;\n\n /**\n * Render override for the empty state. Called when the table has no\n * rows and no error. When omitted, a default \"No Data\" indicator is\n * rendered.\n */\n renderEmptyState?: () => React.ReactNode;\n\n /**\n * The height of each row in pixels.\n *\n * @default 40\n */\n rowHeight?: number;\n\n /**\n * Returns extra HTML attributes (typically `data-*`) to apply to each\n * row element. Use this to drive conditional row styling\n */\n getRowAttributes?: (\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>\n ) => Record<string, string | undefined>;\n\n /**\n * Imperative handle for programmatic table actions. Pass a ref\n * (`useRef<ObjectTableHandle<Q, RDPs>>(null)`) to call\n * {@link ObjectTableHandle} methods such as\n * {@link ObjectTableHandle.getSnapshot}.\n */\n tableRef?: React.Ref<ObjectTableHandle<Q, RDPs>>;\n\n className?: string;\n\n /**\n * Overrides for the table's user-facing strings. Provide any subset; unset keys fall\n * back to the built-in English defaults. Use this to localize the table or\n * adjust wording. See {@link ObjectTableLabels}.\n *\n * @default undefined (built-in English strings)\n */\n labels?: Partial<ObjectTableLabels>;\n}\n\n/**\n * Imperative handle exposing programmatic actions on an {@link ObjectTable}.\n * Obtain it by passing {@link ObjectTableProps.tableRef}.\n */\nexport interface ObjectTableHandle<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n> {\n /**\n * Loads every row matching the object set and returns a format-agnostic\n * snapshot of the table's columns, row values, and total count. The caller\n * is responsible for turning the snapshot into a downloadable artifact\n * (CSV, Excel, JSON, clipboard, …).\n *\n * Property, derived-property, and function-backed columns are included.\n * Function-backed cells are fetched per page during snapshot collection;\n * when a page's fetch fails, `row.getValue(columnId)` returns the thrown\n * `Error` instance for the affected cells while the rest of the snapshot\n * resolves normally.\n * Columns defined with `locator.type === \"custom\"` are omitted because\n * they have no underlying value to export.\n *\n * The returned promise rejects up front when the object set's `totalCount`\n * exceeds `rowLimit`. When `totalCount` is unavailable, it instead rejects\n * mid-load once more than `rowLimit` rows have been pulled, so an unknown\n * count can't drain an unbounded set into the client. Otherwise every\n * matching row is loaded.\n *\n * @param options See {@link ObjectTableSnapshotOptions}.\n */\n getSnapshot: (\n options?: ObjectTableSnapshotOptions\n ) => Promise<ObjectTableSnapshot<Q, RDPs>>;\n}\n\n/**\n * Options for {@link ObjectTableHandle[\"getSnapshot\"]}.\n */\nexport interface ObjectTableSnapshotOptions {\n /**\n * Upper bound on how many rows the snapshot may contain. When the object\n * set's total row count exceeds this value, `getSnapshot` rejects;\n * otherwise every matching row is loaded.\n *\n * @default 10_000\n */\n rowLimit?: number;\n}\n\n/**\n * A point-in-time capture of an {@link ObjectTable}'s columns and row values,\n * returned by {@link ObjectTableHandle.getSnapshot}.\n */\nexport interface ObjectTableSnapshot<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n> {\n columns: ObjectTableDataColumn[];\n rows: ObjectTableDataRow<Q, RDPs>[];\n /**\n * Total number of objects matching the underlying object set, as reported\n * by the API. `undefined` when the API did not provide a count. Encoded as\n * a string to match the underlying list-payload representation.\n */\n totalCount: string | undefined;\n}\n\n/**\n * A single column in an {@link ObjectTableSnapshot}.\n */\nexport interface ObjectTableDataColumn {\n /** Column id, matching the `locator.id` of the column definition. */\n id: string;\n /** Display name shown in the table header. */\n name: string;\n}\n\n/**\n * A single row in an {@link ObjectTableSnapshot}.\n */\nexport interface ObjectTableDataRow<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n> {\n /** Row id (the underlying object's `$primaryKey` rendered as a string). */\n id: string;\n /** The underlying loaded object. */\n object: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>;\n /**\n * Returns the cell value for a given column id, or `undefined` when the\n * column is not part of the snapshot. Function-backed cells whose query\n * failed surface the thrown `Error` instance as their value.\n */\n getValue: (columnId: string) => unknown;\n}\n\n/**\n * Payload for {@link ObjectTableProps.onRowSelectionChanged}. Consolidates\n * the loaded row instances, the `isSelectAll` semantic intent, and an\n * `ObjectSet` covering the selection.\n */\nexport interface RowSelectionChange<\n Q extends ObjectOrInterfaceDefinition,\n RDPs extends Record<string, SimplePropertyDef> = Record<string, never>,\n> {\n /**\n * Loaded row instances currently selected. When `isSelectAll` is true,\n * this reflects only the rows currently in the table — pages not yet\n * fetched are absent. Use `objectSet` for the cross-page view, and\n * `selectedRows.map(r => r.$primaryKey)` if you need the primary keys.\n */\n selectedRows: Osdk.Instance<Q, \"$allBaseProperties\", PropertyKeys<Q>, RDPs>[];\n\n /**\n * True when the user invoked \"select all\" (header checkbox) or when\n * controlled mode supplies `isAllSelected={true}`. Distinct from \"every\n * loaded row happens to be selected\" — that condition is reflected by\n * `selectedRows.length` matching the visible row count but does not set\n * this flag.\n */\n isSelectAll: boolean;\n\n /**\n * An `ObjectSet` representing the selection.\n *\n * - \"Select all\" → the underlying `ObjectSet` (`objectSet` prop if\n * provided, otherwise derived from `objectType` via `client(...)`).\n * This includes rows not yet loaded into the table.\n * - Partial selection → the underlying `ObjectSet` narrowed to\n * `{ $primaryKey: { $in: selectedRows.map(r => r.$primaryKey) } }`.\n * - \"Deselect all\" → an empty `ObjectSet` (`$in: []`).\n *\n * Works for both object and interface types, since the `$primaryKey`\n * special property does not require resolving the underlying primary key\n * property name. `undefined` only when there is no underlying `ObjectSet`\n * to derive from.\n */\n objectSet: ObjectSet<Q, RDPs> | undefined;\n}\n\nexport interface ObjectSetOptions<Q extends ObjectOrInterfaceDefinition> {\n /**\n * Object sets to union with\n */\n union?: ObjectSet<Q>[];\n\n /**\n * Object sets to intersect with\n */\n intersect?: ObjectSet<Q>[];\n\n /**\n * Object sets to subtract from\n */\n subtract?: ObjectSet<Q>[];\n}\n"],"mappings":"","ignoreList":[]}
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Copyright 2026 Palantir Technologies, Inc. All rights reserved.
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
|
|
17
|
+
import { isEqual } from "lodash-es";
|
|
18
|
+
import React, { createContext, useContext, useRef } from "react";
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* All user-facing strings rendered by the object table and its
|
|
22
|
+
* sub-components.
|
|
23
|
+
*/
|
|
24
|
+
|
|
25
|
+
export const DEFAULT_OBJECT_TABLE_LABELS = {
|
|
26
|
+
noData: "No Data",
|
|
27
|
+
errorLoadingData: errorMessage => `Error Loading Data: ${errorMessage}`,
|
|
28
|
+
editFooterEditTable: "Edit Table",
|
|
29
|
+
editFooterSubmitEdits: "Submit Edits",
|
|
30
|
+
editFooterCancel: "Cancel",
|
|
31
|
+
editFooterSelectRowToEdit: "Select a row to edit data…",
|
|
32
|
+
editFooterModificationCount: count => `${count} modifications`,
|
|
33
|
+
editFooterValidationError: "Validation error",
|
|
34
|
+
cellValidationError: "Validation error",
|
|
35
|
+
columnConfigTitle: "Configure Table Columns",
|
|
36
|
+
columnConfigCancel: "Cancel",
|
|
37
|
+
columnConfigApply: "Apply",
|
|
38
|
+
columnConfigVisibleColumns: "Visible Columns",
|
|
39
|
+
columnConfigDragToReorder: "Drag to reorder",
|
|
40
|
+
columnConfigAddOrRemoveColumns: "Add or Remove Columns",
|
|
41
|
+
columnConfigAllColumns: "All Columns",
|
|
42
|
+
columnConfigNoVisibleColumns: "No visible columns",
|
|
43
|
+
columnConfigNoMatchingColumns: "No matching columns found",
|
|
44
|
+
columnConfigSearchPlaceholder: "Search...",
|
|
45
|
+
columnConfigSearchAriaLabel: "Search available columns",
|
|
46
|
+
sortDialogTitle: "Sort on Multiple Columns",
|
|
47
|
+
sortDialogCancel: "Cancel",
|
|
48
|
+
sortDialogApply: "Apply",
|
|
49
|
+
sortDialogAddColumnToSort: "Add Column to Sort",
|
|
50
|
+
sortDialogSearchPlaceholder: "Search columns",
|
|
51
|
+
sortDialogNoMatchingColumns: "No matching columns",
|
|
52
|
+
sortDialogToggleDirection: columnName => `Toggle sort direction for ${columnName}`,
|
|
53
|
+
headerMenuPinColumn: "Pin column",
|
|
54
|
+
headerMenuUnpinColumn: "Unpin Column",
|
|
55
|
+
headerMenuSortAscending: "Sort ascending",
|
|
56
|
+
headerMenuSortDescending: "Sort descending",
|
|
57
|
+
headerMenuSortOnMultipleColumns: "Sort on multiple columns",
|
|
58
|
+
headerMenuClearAllSorts: "Clear all sorts",
|
|
59
|
+
headerMenuResetColumnSize: "Reset Column Size",
|
|
60
|
+
headerMenuConfigureColumns: "Configure Columns",
|
|
61
|
+
headerMenuAriaLabel: columnId => `Open header menu for column with id=${columnId}`,
|
|
62
|
+
cellError: "Error",
|
|
63
|
+
cellNoValue: "No value",
|
|
64
|
+
selectAllRows: "Select all rows",
|
|
65
|
+
deselectAllRows: "Deselect all rows",
|
|
66
|
+
selectRow: rowNumber => `Select row ${rowNumber}`
|
|
67
|
+
};
|
|
68
|
+
const ObjectTableLabelsContext = /*#__PURE__*/createContext(DEFAULT_OBJECT_TABLE_LABELS);
|
|
69
|
+
/**
|
|
70
|
+
* Supplies overridden {@link ObjectTableLabels} to descendant table
|
|
71
|
+
* sub-components via context. Merges `labels` over the labels from the nearest
|
|
72
|
+
* ancestor provider, so a wrapping `ObjectTable`/`BaseTable` and an inner
|
|
73
|
+
* dialog can each override a different subset.
|
|
74
|
+
*
|
|
75
|
+
* The provided value keeps a stable identity across renders whenever the
|
|
76
|
+
* merged labels are equal, so callers can pass an inline `labels` object
|
|
77
|
+
* without re-rendering every label consumer.
|
|
78
|
+
*/
|
|
79
|
+
export function ObjectTableLabelsProvider({
|
|
80
|
+
labels,
|
|
81
|
+
children
|
|
82
|
+
}) {
|
|
83
|
+
const parent = useContext(ObjectTableLabelsContext);
|
|
84
|
+
const merged = labels != null ? {
|
|
85
|
+
...parent,
|
|
86
|
+
...labels
|
|
87
|
+
} : parent;
|
|
88
|
+
|
|
89
|
+
// Reuse the previous value when the merge is equal so an inline `labels`
|
|
90
|
+
// object (new identity each render) doesn't churn the context.
|
|
91
|
+
const stableRef = useRef(merged);
|
|
92
|
+
if (!isEqual(stableRef.current, merged)) {
|
|
93
|
+
stableRef.current = merged;
|
|
94
|
+
}
|
|
95
|
+
return /*#__PURE__*/React.createElement(ObjectTableLabelsContext.Provider, {
|
|
96
|
+
value: stableRef.current
|
|
97
|
+
}, children);
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Returns the fully-resolved {@link ObjectTableLabels} for the current subtree.
|
|
102
|
+
* When no {@link ObjectTableLabelsProvider} is present, returns
|
|
103
|
+
* {@link DEFAULT_OBJECT_TABLE_LABELS}.
|
|
104
|
+
*/
|
|
105
|
+
export function useObjectTableLabels() {
|
|
106
|
+
return useContext(ObjectTableLabelsContext);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* Wraps `Inner` so it accepts an optional `labels` prop and supplies the merged
|
|
111
|
+
* {@link ObjectTableLabels} to its subtree.
|
|
112
|
+
*
|
|
113
|
+
* For generic components, e.g. `BaseTable` use
|
|
114
|
+
* {@link ObjectTableLabelsProvider} directly to preserve its `TData`
|
|
115
|
+
* type parameter.
|
|
116
|
+
*/
|
|
117
|
+
export function withObjectTableLabels(Inner) {
|
|
118
|
+
function LabelledComponent(props) {
|
|
119
|
+
const {
|
|
120
|
+
labels,
|
|
121
|
+
...rest
|
|
122
|
+
} = props;
|
|
123
|
+
return /*#__PURE__*/React.createElement(ObjectTableLabelsProvider, {
|
|
124
|
+
labels: labels
|
|
125
|
+
}, /*#__PURE__*/React.createElement(Inner, rest));
|
|
126
|
+
}
|
|
127
|
+
LabelledComponent.displayName = `withObjectTableLabels(${Inner.displayName})`;
|
|
128
|
+
return LabelledComponent;
|
|
129
|
+
}
|
|
130
|
+
//# sourceMappingURL=ObjectTableLabels.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"ObjectTableLabels.js","names":["isEqual","React","createContext","useContext","useRef","DEFAULT_OBJECT_TABLE_LABELS","noData","errorLoadingData","errorMessage","editFooterEditTable","editFooterSubmitEdits","editFooterCancel","editFooterSelectRowToEdit","editFooterModificationCount","count","editFooterValidationError","cellValidationError","columnConfigTitle","columnConfigCancel","columnConfigApply","columnConfigVisibleColumns","columnConfigDragToReorder","columnConfigAddOrRemoveColumns","columnConfigAllColumns","columnConfigNoVisibleColumns","columnConfigNoMatchingColumns","columnConfigSearchPlaceholder","columnConfigSearchAriaLabel","sortDialogTitle","sortDialogCancel","sortDialogApply","sortDialogAddColumnToSort","sortDialogSearchPlaceholder","sortDialogNoMatchingColumns","sortDialogToggleDirection","columnName","headerMenuPinColumn","headerMenuUnpinColumn","headerMenuSortAscending","headerMenuSortDescending","headerMenuSortOnMultipleColumns","headerMenuClearAllSorts","headerMenuResetColumnSize","headerMenuConfigureColumns","headerMenuAriaLabel","columnId","cellError","cellNoValue","selectAllRows","deselectAllRows","selectRow","rowNumber","ObjectTableLabelsContext","ObjectTableLabelsProvider","labels","children","parent","merged","stableRef","current","createElement","Provider","value","useObjectTableLabels","withObjectTableLabels","Inner","LabelledComponent","props","rest","displayName"],"sources":["ObjectTableLabels.tsx"],"sourcesContent":["/*\n * Copyright 2026 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { isEqual } from \"lodash-es\";\nimport React, {\n createContext,\n type ReactElement,\n type ReactNode,\n useContext,\n useRef,\n} from \"react\";\n\n/**\n * All user-facing strings rendered by the object table and its\n * sub-components.\n */\nexport interface ObjectTableLabels {\n /**\n * Shown in the table body when there are no rows and no error, unless a\n * `renderEmptyState` override is supplied.\n * @default \"No Data\"\n */\n noData: string;\n /**\n * Shown in the table body when data loading fails.\n * @default (errorMessage) => `Error Loading Data: ${errorMessage}`\n */\n errorLoadingData: (errorMessage: string) => string;\n\n /** @default \"Edit Table\" */\n editFooterEditTable: string;\n /** @default \"Submit Edits\" */\n editFooterSubmitEdits: string;\n /** @default \"Cancel\" */\n editFooterCancel: string;\n /** @default \"Select a row to edit data…\" */\n editFooterSelectRowToEdit: string;\n /** @default (count) => `${count} modifications` */\n editFooterModificationCount: (count: number) => string;\n /** Shown in the edit-footer badge when a cell fails validation.\n * @default \"Validation error\" */\n editFooterValidationError: string;\n\n /**\n * Fallback message surfaced when a column's `validateEdit` rejects (throws)\n * rather than resolving with a message. Messages returned by `validateEdit`\n * itself are surfaced verbatim and are not affected by this label.\n * @default \"Validation error\"\n */\n cellValidationError: string;\n\n /** @default \"Configure Table Columns\" */\n columnConfigTitle: string;\n /** @default \"Cancel\" */\n columnConfigCancel: string;\n /** @default \"Apply\" */\n columnConfigApply: string;\n /** @default \"Visible Columns\" */\n columnConfigVisibleColumns: string;\n /** @default \"Drag to reorder\" */\n columnConfigDragToReorder: string;\n /** @default \"Add or Remove Columns\" */\n columnConfigAddOrRemoveColumns: string;\n /** @default \"All Columns\" */\n columnConfigAllColumns: string;\n /** @default \"No visible columns\" */\n columnConfigNoVisibleColumns: string;\n /** @default \"No matching columns found\" */\n columnConfigNoMatchingColumns: string;\n /** @default \"Search...\" */\n columnConfigSearchPlaceholder: string;\n /** @default \"Search available columns\" */\n columnConfigSearchAriaLabel: string;\n\n /** @default \"Sort on Multiple Columns\" */\n sortDialogTitle: string;\n /** @default \"Cancel\" */\n sortDialogCancel: string;\n /** @default \"Apply\" */\n sortDialogApply: string;\n /** @default \"Add Column to Sort\" */\n sortDialogAddColumnToSort: string;\n /** @default \"Search columns\" */\n sortDialogSearchPlaceholder: string;\n /** @default \"No matching columns\" */\n sortDialogNoMatchingColumns: string;\n /** @default (columnName) => `Toggle sort direction for ${columnName}` */\n sortDialogToggleDirection: (columnName: string) => string;\n\n /** @default \"Pin column\" */\n headerMenuPinColumn: string;\n /** @default \"Unpin Column\" */\n headerMenuUnpinColumn: string;\n /** @default \"Sort ascending\" */\n headerMenuSortAscending: string;\n /** @default \"Sort descending\" */\n headerMenuSortDescending: string;\n /** @default \"Sort on multiple columns\" */\n headerMenuSortOnMultipleColumns: string;\n /** @default \"Clear all sorts\" */\n headerMenuClearAllSorts: string;\n /** @default \"Reset Column Size\" */\n headerMenuResetColumnSize: string;\n /** @default \"Configure Columns\" */\n headerMenuConfigureColumns: string;\n /** @default (columnId) => `Open header menu for column with id=${columnId}` */\n headerMenuAriaLabel: (columnId: string) => string;\n\n /** @default \"Error\" */\n cellError: string;\n /** @default \"No value\" */\n cellNoValue: string;\n\n /** @default \"Select all rows\" */\n selectAllRows: string;\n /** @default \"Deselect all rows\" */\n deselectAllRows: string;\n /** @default (rowNumber) => `Select row ${rowNumber}` */\n selectRow: (rowNumber: number) => string;\n}\n\nexport const DEFAULT_OBJECT_TABLE_LABELS: ObjectTableLabels = {\n noData: \"No Data\",\n errorLoadingData: (errorMessage) => `Error Loading Data: ${errorMessage}`,\n\n editFooterEditTable: \"Edit Table\",\n editFooterSubmitEdits: \"Submit Edits\",\n editFooterCancel: \"Cancel\",\n editFooterSelectRowToEdit: \"Select a row to edit data…\",\n editFooterModificationCount: (count) => `${count} modifications`,\n editFooterValidationError: \"Validation error\",\n\n cellValidationError: \"Validation error\",\n\n columnConfigTitle: \"Configure Table Columns\",\n columnConfigCancel: \"Cancel\",\n columnConfigApply: \"Apply\",\n columnConfigVisibleColumns: \"Visible Columns\",\n columnConfigDragToReorder: \"Drag to reorder\",\n columnConfigAddOrRemoveColumns: \"Add or Remove Columns\",\n columnConfigAllColumns: \"All Columns\",\n columnConfigNoVisibleColumns: \"No visible columns\",\n columnConfigNoMatchingColumns: \"No matching columns found\",\n columnConfigSearchPlaceholder: \"Search...\",\n columnConfigSearchAriaLabel: \"Search available columns\",\n\n sortDialogTitle: \"Sort on Multiple Columns\",\n sortDialogCancel: \"Cancel\",\n sortDialogApply: \"Apply\",\n sortDialogAddColumnToSort: \"Add Column to Sort\",\n sortDialogSearchPlaceholder: \"Search columns\",\n sortDialogNoMatchingColumns: \"No matching columns\",\n sortDialogToggleDirection: (columnName) =>\n `Toggle sort direction for ${columnName}`,\n\n headerMenuPinColumn: \"Pin column\",\n headerMenuUnpinColumn: \"Unpin Column\",\n headerMenuSortAscending: \"Sort ascending\",\n headerMenuSortDescending: \"Sort descending\",\n headerMenuSortOnMultipleColumns: \"Sort on multiple columns\",\n headerMenuClearAllSorts: \"Clear all sorts\",\n headerMenuResetColumnSize: \"Reset Column Size\",\n headerMenuConfigureColumns: \"Configure Columns\",\n headerMenuAriaLabel: (columnId) =>\n `Open header menu for column with id=${columnId}`,\n\n cellError: \"Error\",\n cellNoValue: \"No value\",\n\n selectAllRows: \"Select all rows\",\n deselectAllRows: \"Deselect all rows\",\n selectRow: (rowNumber) => `Select row ${rowNumber}`,\n};\n\nconst ObjectTableLabelsContext = createContext<ObjectTableLabels>(\n DEFAULT_OBJECT_TABLE_LABELS\n);\n\nexport interface ObjectTableLabelsProviderProps {\n labels?: Partial<ObjectTableLabels>;\n children: ReactNode;\n}\n\n/**\n * Supplies overridden {@link ObjectTableLabels} to descendant table\n * sub-components via context. Merges `labels` over the labels from the nearest\n * ancestor provider, so a wrapping `ObjectTable`/`BaseTable` and an inner\n * dialog can each override a different subset.\n *\n * The provided value keeps a stable identity across renders whenever the\n * merged labels are equal, so callers can pass an inline `labels` object\n * without re-rendering every label consumer.\n */\nexport function ObjectTableLabelsProvider({\n labels,\n children,\n}: ObjectTableLabelsProviderProps): ReactElement {\n const parent = useContext(ObjectTableLabelsContext);\n const merged = labels != null ? { ...parent, ...labels } : parent;\n\n // Reuse the previous value when the merge is equal so an inline `labels`\n // object (new identity each render) doesn't churn the context.\n const stableRef = useRef(merged);\n if (!isEqual(stableRef.current, merged)) {\n stableRef.current = merged;\n }\n\n return (\n <ObjectTableLabelsContext.Provider value={stableRef.current}>\n {children}\n </ObjectTableLabelsContext.Provider>\n );\n}\n\n/**\n * Returns the fully-resolved {@link ObjectTableLabels} for the current subtree.\n * When no {@link ObjectTableLabelsProvider} is present, returns\n * {@link DEFAULT_OBJECT_TABLE_LABELS}.\n */\nexport function useObjectTableLabels(): ObjectTableLabels {\n return useContext(ObjectTableLabelsContext);\n}\n\n/**\n * Wraps `Inner` so it accepts an optional `labels` prop and supplies the merged\n * {@link ObjectTableLabels} to its subtree.\n *\n * For generic components, e.g. `BaseTable` use\n * {@link ObjectTableLabelsProvider} directly to preserve its `TData`\n * type parameter.\n */\nexport function withObjectTableLabels<P extends object>(\n Inner: React.ComponentType<P>\n): React.FC<P & { labels?: Partial<ObjectTableLabels> }> {\n function LabelledComponent(\n props: P & { labels?: Partial<ObjectTableLabels> }\n ): ReactElement {\n const { labels, ...rest } = props;\n return (\n <ObjectTableLabelsProvider labels={labels}>\n <Inner {...(rest as unknown as P)} />\n </ObjectTableLabelsProvider>\n );\n }\n LabelledComponent.displayName = `withObjectTableLabels(${Inner.displayName})`;\n return LabelledComponent;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,OAAO,QAAQ,WAAW;AACnC,OAAOC,KAAK,IACVC,aAAa,EAGbC,UAAU,EACVC,MAAM,QACD,OAAO;;AAEd;AACA;AACA;AACA;;AA0GA,OAAO,MAAMC,2BAA8C,GAAG;EAC5DC,MAAM,EAAE,SAAS;EACjBC,gBAAgB,EAAGC,YAAY,IAAK,uBAAuBA,YAAY,EAAE;EAEzEC,mBAAmB,EAAE,YAAY;EACjCC,qBAAqB,EAAE,cAAc;EACrCC,gBAAgB,EAAE,QAAQ;EAC1BC,yBAAyB,EAAE,4BAA4B;EACvDC,2BAA2B,EAAGC,KAAK,IAAK,GAAGA,KAAK,gBAAgB;EAChEC,yBAAyB,EAAE,kBAAkB;EAE7CC,mBAAmB,EAAE,kBAAkB;EAEvCC,iBAAiB,EAAE,yBAAyB;EAC5CC,kBAAkB,EAAE,QAAQ;EAC5BC,iBAAiB,EAAE,OAAO;EAC1BC,0BAA0B,EAAE,iBAAiB;EAC7CC,yBAAyB,EAAE,iBAAiB;EAC5CC,8BAA8B,EAAE,uBAAuB;EACvDC,sBAAsB,EAAE,aAAa;EACrCC,4BAA4B,EAAE,oBAAoB;EAClDC,6BAA6B,EAAE,2BAA2B;EAC1DC,6BAA6B,EAAE,WAAW;EAC1CC,2BAA2B,EAAE,0BAA0B;EAEvDC,eAAe,EAAE,0BAA0B;EAC3CC,gBAAgB,EAAE,QAAQ;EAC1BC,eAAe,EAAE,OAAO;EACxBC,yBAAyB,EAAE,oBAAoB;EAC/CC,2BAA2B,EAAE,gBAAgB;EAC7CC,2BAA2B,EAAE,qBAAqB;EAClDC,yBAAyB,EAAGC,UAAU,IACpC,6BAA6BA,UAAU,EAAE;EAE3CC,mBAAmB,EAAE,YAAY;EACjCC,qBAAqB,EAAE,cAAc;EACrCC,uBAAuB,EAAE,gBAAgB;EACzCC,wBAAwB,EAAE,iBAAiB;EAC3CC,+BAA+B,EAAE,0BAA0B;EAC3DC,uBAAuB,EAAE,iBAAiB;EAC1CC,yBAAyB,EAAE,mBAAmB;EAC9CC,0BAA0B,EAAE,mBAAmB;EAC/CC,mBAAmB,EAAGC,QAAQ,IAC5B,uCAAuCA,QAAQ,EAAE;EAEnDC,SAAS,EAAE,OAAO;EAClBC,WAAW,EAAE,UAAU;EAEvBC,aAAa,EAAE,iBAAiB;EAChCC,eAAe,EAAE,mBAAmB;EACpCC,SAAS,EAAGC,SAAS,IAAK,cAAcA,SAAS;AACnD,CAAC;AAED,MAAMC,wBAAwB,gBAAGlD,aAAa,CAC5CG,2BACF,CAAC;AAOD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASgD,yBAAyBA,CAAC;EACxCC,MAAM;EACNC;AAC8B,CAAC,EAAgB;EAC/C,MAAMC,MAAM,GAAGrD,UAAU,CAACiD,wBAAwB,CAAC;EACnD,MAAMK,MAAM,GAAGH,MAAM,IAAI,IAAI,GAAG;IAAE,GAAGE,MAAM;IAAE,GAAGF;EAAO,CAAC,GAAGE,MAAM;;EAEjE;EACA;EACA,MAAME,SAAS,GAAGtD,MAAM,CAACqD,MAAM,CAAC;EAChC,IAAI,CAACzD,OAAO,CAAC0D,SAAS,CAACC,OAAO,EAAEF,MAAM,CAAC,EAAE;IACvCC,SAAS,CAACC,OAAO,GAAGF,MAAM;EAC5B;EAEA,oBACExD,KAAA,CAAA2D,aAAA,CAACR,wBAAwB,CAACS,QAAQ;IAACC,KAAK,EAAEJ,SAAS,CAACC;EAAQ,GACzDJ,QACgC,CAAC;AAExC;;AAEA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASQ,oBAAoBA,CAAA,EAAsB;EACxD,OAAO5D,UAAU,CAACiD,wBAAwB,CAAC;AAC7C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASY,qBAAqBA,CACnCC,KAA6B,EAC0B;EACvD,SAASC,iBAAiBA,CACxBC,KAAkD,EACpC;IACd,MAAM;MAAEb,MAAM;MAAE,GAAGc;IAAK,CAAC,GAAGD,KAAK;IACjC,oBACElE,KAAA,CAAA2D,aAAA,CAACP,yBAAyB;MAACC,MAAM,EAAEA;IAAO,gBACxCrD,KAAA,CAAA2D,aAAA,CAACK,KAAK,EAAMG,IAAwB,CACX,CAAC;EAEhC;EACAF,iBAAiB,CAACG,WAAW,GAAG,yBAAyBJ,KAAK,CAACI,WAAW,GAAG;EAC7E,OAAOH,iBAAiB;AAC1B","ignoreList":[]}
|
|
@@ -16,12 +16,14 @@
|
|
|
16
16
|
|
|
17
17
|
import React, { useCallback } from "react";
|
|
18
18
|
import { Checkbox } from "../base-components/checkbox/Checkbox.js";
|
|
19
|
+
import { useObjectTableLabels } from "./ObjectTableLabels.js";
|
|
19
20
|
export function SelectionHeaderCell({
|
|
20
21
|
isAllSelected,
|
|
21
22
|
hasSelection,
|
|
22
23
|
onToggleAll
|
|
23
24
|
}) {
|
|
24
|
-
const
|
|
25
|
+
const labels = useObjectTableLabels();
|
|
26
|
+
const checkboxLabel = hasSelection ? labels.deselectAllRows : labels.selectAllRows;
|
|
25
27
|
return /*#__PURE__*/React.createElement(Checkbox, {
|
|
26
28
|
indeterminate: hasSelection && !isAllSelected,
|
|
27
29
|
checked: isAllSelected,
|
|
@@ -33,6 +35,7 @@ export function SelectionCell({
|
|
|
33
35
|
row,
|
|
34
36
|
onToggleRow
|
|
35
37
|
}) {
|
|
38
|
+
const labels = useObjectTableLabels();
|
|
36
39
|
const handleClick = useCallback(event => {
|
|
37
40
|
// TODO: Create ActionBoundary component
|
|
38
41
|
event.stopPropagation();
|
|
@@ -52,7 +55,7 @@ export function SelectionCell({
|
|
|
52
55
|
onKeyDown: handleKeyDown
|
|
53
56
|
}, /*#__PURE__*/React.createElement(Checkbox, {
|
|
54
57
|
checked: row.getIsSelected(),
|
|
55
|
-
"aria-label":
|
|
58
|
+
"aria-label": labels.selectRow(row.index + 1)
|
|
56
59
|
}));
|
|
57
60
|
}
|
|
58
61
|
//# sourceMappingURL=SelectionCells.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SelectionCells.js","names":["React","useCallback","Checkbox","SelectionHeaderCell","isAllSelected","hasSelection","onToggleAll","checkboxLabel","createElement","indeterminate","checked","onCheckedChange","SelectionCell","row","onToggleRow","handleClick","event","stopPropagation","isShiftClick","shiftKey","id","index","handleKeyDown","key","onClick","onKeyDown","getIsSelected"],"sources":["SelectionCells.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Row, RowData } from \"@tanstack/react-table\";\nimport React, { useCallback } from \"react\";\n\nimport { Checkbox } from \"../base-components/checkbox/Checkbox.js\";\n\ninterface SelectionHeaderCellProps {\n isAllSelected: boolean;\n hasSelection: boolean;\n onToggleAll: () => void;\n}\n\nexport function SelectionHeaderCell({\n isAllSelected,\n hasSelection,\n onToggleAll,\n}: SelectionHeaderCellProps): React.ReactElement {\n const checkboxLabel = hasSelection
|
|
1
|
+
{"version":3,"file":"SelectionCells.js","names":["React","useCallback","Checkbox","useObjectTableLabels","SelectionHeaderCell","isAllSelected","hasSelection","onToggleAll","labels","checkboxLabel","deselectAllRows","selectAllRows","createElement","indeterminate","checked","onCheckedChange","SelectionCell","row","onToggleRow","handleClick","event","stopPropagation","isShiftClick","shiftKey","id","index","handleKeyDown","key","onClick","onKeyDown","getIsSelected","selectRow"],"sources":["SelectionCells.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Row, RowData } from \"@tanstack/react-table\";\nimport React, { useCallback } from \"react\";\n\nimport { Checkbox } from \"../base-components/checkbox/Checkbox.js\";\nimport { useObjectTableLabels } from \"./ObjectTableLabels.js\";\n\ninterface SelectionHeaderCellProps {\n isAllSelected: boolean;\n hasSelection: boolean;\n onToggleAll: () => void;\n}\n\nexport function SelectionHeaderCell({\n isAllSelected,\n hasSelection,\n onToggleAll,\n}: SelectionHeaderCellProps): React.ReactElement {\n const labels = useObjectTableLabels();\n const checkboxLabel = hasSelection\n ? labels.deselectAllRows\n : labels.selectAllRows;\n\n return (\n <Checkbox\n indeterminate={hasSelection && !isAllSelected}\n checked={isAllSelected}\n onCheckedChange={onToggleAll}\n aria-label={checkboxLabel}\n />\n );\n}\n\ninterface SelectionCellProps<TData extends RowData> {\n row: Row<TData>;\n onToggleRow: (rowId: string, rowIndex: number, isShiftClick: boolean) => void;\n}\n\nexport function SelectionCell<TData extends RowData>({\n row,\n onToggleRow,\n}: SelectionCellProps<TData>): React.ReactElement {\n const labels = useObjectTableLabels();\n const handleClick = useCallback(\n (event: React.MouseEvent<HTMLDivElement, MouseEvent>) => {\n // TODO: Create ActionBoundary component\n event.stopPropagation();\n const isShiftClick = event.shiftKey;\n onToggleRow(row.id, row.index, isShiftClick);\n },\n [onToggleRow, row.id, row.index]\n );\n\n const handleKeyDown = useCallback(\n (event: React.KeyboardEvent<HTMLDivElement>) => {\n // TODO: support shift + space\n // It looks like when we handle shift key here, the checkbox gets toggled twice\n if (event.key === \"Enter\") {\n const isShiftClick = event.shiftKey;\n onToggleRow(row.id, row.index, isShiftClick);\n }\n },\n [onToggleRow, row.id, row.index]\n );\n\n return (\n <div onClick={handleClick} onKeyDown={handleKeyDown}>\n <Checkbox\n checked={row.getIsSelected()}\n aria-label={labels.selectRow(row.index + 1)}\n />\n </div>\n );\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,OAAOA,KAAK,IAAIC,WAAW,QAAQ,OAAO;AAE1C,SAASC,QAAQ,QAAQ,yCAAyC;AAClE,SAASC,oBAAoB,QAAQ,wBAAwB;AAQ7D,OAAO,SAASC,mBAAmBA,CAAC;EAClCC,aAAa;EACbC,YAAY;EACZC;AACwB,CAAC,EAAsB;EAC/C,MAAMC,MAAM,GAAGL,oBAAoB,CAAC,CAAC;EACrC,MAAMM,aAAa,GAAGH,YAAY,GAC9BE,MAAM,CAACE,eAAe,GACtBF,MAAM,CAACG,aAAa;EAExB,oBACEX,KAAA,CAAAY,aAAA,CAACV,QAAQ;IACPW,aAAa,EAAEP,YAAY,IAAI,CAACD,aAAc;IAC9CS,OAAO,EAAET,aAAc;IACvBU,eAAe,EAAER,WAAY;IAC7B,cAAYE;EAAc,CAC3B,CAAC;AAEN;AAOA,OAAO,SAASO,aAAaA,CAAwB;EACnDC,GAAG;EACHC;AACyB,CAAC,EAAsB;EAChD,MAAMV,MAAM,GAAGL,oBAAoB,CAAC,CAAC;EACrC,MAAMgB,WAAW,GAAGlB,WAAW,CAC5BmB,KAAmD,IAAK;IACvD;IACAA,KAAK,CAACC,eAAe,CAAC,CAAC;IACvB,MAAMC,YAAY,GAAGF,KAAK,CAACG,QAAQ;IACnCL,WAAW,CAACD,GAAG,CAACO,EAAE,EAAEP,GAAG,CAACQ,KAAK,EAAEH,YAAY,CAAC;EAC9C,CAAC,EACD,CAACJ,WAAW,EAAED,GAAG,CAACO,EAAE,EAAEP,GAAG,CAACQ,KAAK,CACjC,CAAC;EAED,MAAMC,aAAa,GAAGzB,WAAW,CAC9BmB,KAA0C,IAAK;IAC9C;IACA;IACA,IAAIA,KAAK,CAACO,GAAG,KAAK,OAAO,EAAE;MACzB,MAAML,YAAY,GAAGF,KAAK,CAACG,QAAQ;MACnCL,WAAW,CAACD,GAAG,CAACO,EAAE,EAAEP,GAAG,CAACQ,KAAK,EAAEH,YAAY,CAAC;IAC9C;EACF,CAAC,EACD,CAACJ,WAAW,EAAED,GAAG,CAACO,EAAE,EAAEP,GAAG,CAACQ,KAAK,CACjC,CAAC;EAED,oBACEzB,KAAA,CAAAY,aAAA;IAAKgB,OAAO,EAAET,WAAY;IAACU,SAAS,EAAEH;EAAc,gBAClD1B,KAAA,CAAAY,aAAA,CAACV,QAAQ;IACPY,OAAO,EAAEG,GAAG,CAACa,aAAa,CAAC,CAAE;IAC7B,cAAYtB,MAAM,CAACuB,SAAS,CAACd,GAAG,CAACQ,KAAK,GAAG,CAAC;EAAE,CAC7C,CACE,CAAC;AAEV","ignoreList":[]}
|
|
@@ -20,6 +20,7 @@ import { PortalContainerProvider } from "../shared/PortalContainerContext.js";
|
|
|
20
20
|
import { useFocusedRow } from "./hooks/useFocusedRow.js";
|
|
21
21
|
import { LoadingStateTable } from "./LoadingStateTable.js";
|
|
22
22
|
import { NonIdealState } from "./NonIdealState.js";
|
|
23
|
+
import { ObjectTableLabelsProvider, useObjectTableLabels } from "./ObjectTableLabels.js";
|
|
23
24
|
import { TableBody } from "./TableBody.js";
|
|
24
25
|
import { TableEditContainer } from "./TableEditContainer.js";
|
|
25
26
|
import { TableHeader } from "./TableHeader.js";
|
|
@@ -28,7 +29,9 @@ import { isColumnDeclaredEditable } from "./utils/editableUtils.js";
|
|
|
28
29
|
import { PortalTrackerProvider, usePortalTracker } from "./utils/PortalTracker.js";
|
|
29
30
|
import styles from "./Table.module.css.js";
|
|
30
31
|
export function BaseTable(props) {
|
|
31
|
-
return /*#__PURE__*/React.createElement(
|
|
32
|
+
return /*#__PURE__*/React.createElement(ObjectTableLabelsProvider, {
|
|
33
|
+
labels: props.labels
|
|
34
|
+
}, /*#__PURE__*/React.createElement(PortalTrackerProvider, null, /*#__PURE__*/React.createElement(BaseTableInner, props)));
|
|
32
35
|
}
|
|
33
36
|
function BaseTableInner({
|
|
34
37
|
table,
|
|
@@ -51,6 +54,7 @@ function BaseTableInner({
|
|
|
51
54
|
const tableContainerRef = useRef(null);
|
|
52
55
|
const objectTablePortalRef = useRef(null);
|
|
53
56
|
const [isLoadingMore, setIsLoadingMore] = useState(false);
|
|
57
|
+
const labels = useObjectTableLabels();
|
|
54
58
|
const getRowById = useCallback(id => {
|
|
55
59
|
try {
|
|
56
60
|
return table.getRow(id, true)?.original ?? null;
|
|
@@ -163,9 +167,9 @@ function BaseTableInner({
|
|
|
163
167
|
isInEditMode: editableConfig?.editModeState.isActive,
|
|
164
168
|
getRowAttributes: getRowAttributes
|
|
165
169
|
}))), !hasData && error == null && (renderEmptyState != null ? renderEmptyState() : /*#__PURE__*/React.createElement(NonIdealState, {
|
|
166
|
-
message:
|
|
170
|
+
message: labels.noData
|
|
167
171
|
})), error != null && /*#__PURE__*/React.createElement(NonIdealState, {
|
|
168
|
-
message:
|
|
172
|
+
message: labels.errorLoadingData(error.message)
|
|
169
173
|
})), showEditFooter && hasEditableColumns && editableConfig && /*#__PURE__*/React.createElement(TableEditContainer, {
|
|
170
174
|
editableConfig: editableConfig,
|
|
171
175
|
hasFocusedRow: focusedRowId != null
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Table.js","names":["classNames","React","useCallback","useEffect","useRef","useState","PortalContainerProvider","useFocusedRow","LoadingStateTable","NonIdealState","TableBody","TableEditContainer","TableHeader","SCROLL_FETCH_THRESHOLD","isColumnDeclaredEditable","PortalTrackerProvider","usePortalTracker","styles","BaseTable","props","createElement","BaseTableInner","table","isLoading","fetchNextPage","onRowClick","onColumnHeaderClick","rowHeight","renderCellContextMenu","className","error","headerMenuFeatureFlags","editableConfig","getRowAttributes","showEditFooter","renderEmptyState","focusedRowId","focusedRowIdProp","onFocusedRowChanged","tableContainerRef","objectTablePortalRef","isLoadingMore","setIsLoadingMore","getRowById","id","getRow","original","setFocusedRowId","portalTracker","options","meta","fetchingRef","fetchMoreOnEndReached","containerRefElement","current","scrollHeight","scrollTop","clientHeight","handleScroll","e","currentTarget","rows","getRowModel","headerGroups","getHeaderGroups","hasData","length","hasEditableColumns","getAllColumns","some","column","columnDef","editable","handleClickOutside","event","target","contains","containsElement","document","addEventListener","removeEventListener","container","ref","osdkTableWrapper","osdkTableContainer","onScroll","Fragment","isInEditMode","editModeState","isActive","message","hasFocusedRow"],"sources":["Table.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Cell, RowData, Table } from \"@tanstack/react-table\";\nimport classNames from \"classnames\";\nimport React, {\n type ReactElement,\n useCallback,\n useEffect,\n useRef,\n useState,\n} from \"react\";\n\nimport { PortalContainerProvider } from \"../shared/PortalContainerContext.js\";\nimport { useFocusedRow } from \"./hooks/useFocusedRow.js\";\nimport { LoadingStateTable } from \"./LoadingStateTable.js\";\nimport { NonIdealState } from \"./NonIdealState.js\";\nimport { TableBody } from \"./TableBody.js\";\nimport { TableEditContainer } from \"./TableEditContainer.js\";\nimport { TableHeader } from \"./TableHeader.js\";\nimport type { HeaderMenuFeatureFlags } from \"./TableHeaderWithPopover.js\";\nimport { SCROLL_FETCH_THRESHOLD } from \"./utils/constants.js\";\nimport { isColumnDeclaredEditable } from \"./utils/editableUtils.js\";\nimport {\n PortalTrackerProvider,\n usePortalTracker,\n} from \"./utils/PortalTracker.js\";\nimport type {\n CellEditInfo,\n EditableConfig,\n EditFieldConfig,\n} from \"./utils/types.js\";\n\nimport styles from \"./Table.module.css\";\n\ndeclare module \"@tanstack/react-table\" {\n interface ColumnMeta<TData extends RowData = unknown, TValue = unknown> {\n columnName?: string;\n isAsyncColumn?: boolean;\n isVisible?: boolean;\n editable?: boolean | ((object: TData) => boolean);\n dataType?: string;\n /**\n * For columns backed by a `\"marking\"` property, the marking subtype as\n * surfaced by the platform: `\"CBAC\"` for classification-based access\n * control or `\"MANDATORY\"` for mandatory markings. Absent for\n * non-marking columns and for marking columns whose subtype isn't\n * exposed.\n */\n markingType?: \"CBAC\" | \"MANDATORY\";\n editFieldConfig?: EditFieldConfig<TData>;\n validateEdit?: (value: unknown) => Promise<string | undefined>;\n }\n interface TableMeta<TData extends RowData = unknown> {\n onCellEdit?: (cellId: string, info: CellEditInfo<TData, unknown>) => void;\n onCellValidationError?: (cellId: string, error: string) => void;\n clearCellValidationError?: (cellId: string) => void;\n cellEdits?: Record<string, CellEditInfo<TData, unknown>>;\n isInEditMode?: boolean;\n validationErrors?: Map<string, string>;\n focusedRowId?: string | null;\n }\n}\n\nexport interface BaseTableProps<TData extends RowData> {\n table: Table<TData>;\n isLoading?: boolean;\n fetchNextPage?: () => Promise<void>;\n onRowClick?: (row: TData) => void;\n onColumnHeaderClick?: (columnId: string) => void;\n rowHeight?: number;\n renderCellContextMenu?: (\n row: TData,\n cell: Cell<TData, unknown>\n ) => React.ReactNode;\n className?: string;\n error?: Error;\n headerMenuFeatureFlags?: HeaderMenuFeatureFlags;\n editableConfig?: EditableConfig<TData, unknown>;\n getRowAttributes?: (object: TData) => Record<string, string | undefined>;\n /**\n * Whether to render the bottom edit footer. Defaults to `true`; the\n * footer is only rendered when the table has at least one editable\n * column (`hasEditableColumns`).\n */\n showEditFooter?: boolean;\n /**\n * Render override for the empty state. Called when the table has no\n * rows and no error. When omitted, a default \"No Data\" indicator is\n * rendered.\n */\n renderEmptyState?: () => React.ReactNode;\n /**\n * Controlled focused row id. `undefined` enables internal management\n */\n focusedRowId?: string | null;\n /**\n * Fires whenever the focused row changes, in both controlled and\n * uncontrolled modes.\n */\n onFocusedRowChanged?: (row: TData | null) => void;\n}\n\nexport function BaseTable<TData extends RowData>(\n props: BaseTableProps<TData>\n): ReactElement {\n return (\n <PortalTrackerProvider>\n <BaseTableInner {...props} />\n </PortalTrackerProvider>\n );\n}\n\nfunction BaseTableInner<TData extends RowData>({\n table,\n isLoading,\n fetchNextPage,\n onRowClick,\n onColumnHeaderClick,\n rowHeight,\n renderCellContextMenu,\n className,\n error,\n headerMenuFeatureFlags,\n editableConfig,\n getRowAttributes,\n showEditFooter = true,\n renderEmptyState,\n focusedRowId: focusedRowIdProp,\n onFocusedRowChanged,\n}: BaseTableProps<TData>): ReactElement {\n const tableContainerRef = useRef<HTMLDivElement>(null);\n const objectTablePortalRef = useRef<HTMLDivElement>(null);\n const [isLoadingMore, setIsLoadingMore] = useState(false);\n\n const getRowById = useCallback(\n (id: string) => {\n try {\n return table.getRow(id, true)?.original ?? null;\n } catch {\n // table.getRow throws when the id no longer matches a row\n // (e.g. the row was removed or has not loaded yet). Treat a\n // missing row as \"no focus\" rather than crashing.\n return null;\n }\n },\n [table]\n );\n\n const { focusedRowId, setFocusedRowId } = useFocusedRow<TData>({\n focusedRowId: focusedRowIdProp,\n onFocusedRowChanged,\n getRowById,\n });\n const portalTracker = usePortalTracker();\n\n // Sync focusedRowId into table meta so cell renderers (which only\n // receive `table`) can read it without extra prop drilling.\n // Assigned synchronously so children see the current value in the\n // same render pass. This is safe because meta is a mutable bag that\n // TanStack Table never snapshots or shallow-compares.\n if (table.options.meta) {\n table.options.meta.focusedRowId = focusedRowId;\n }\n\n // Using a ref to prevent duplicate fetches from rapid scroll events while a fetch is in-flight\n const fetchingRef = useRef(false);\n\n useEffect(() => {\n if (!isLoading || fetchNextPage == null) {\n setIsLoadingMore(false);\n }\n }, [isLoading, fetchNextPage]);\n\n const fetchMoreOnEndReached = useCallback(\n async (containerRefElement?: HTMLDivElement | null) => {\n if (containerRefElement && !fetchingRef.current && !isLoadingMore) {\n const { scrollHeight, scrollTop, clientHeight } = containerRefElement;\n if (\n scrollHeight - scrollTop - clientHeight < SCROLL_FETCH_THRESHOLD &&\n !isLoading &&\n fetchNextPage != null\n ) {\n fetchingRef.current = true;\n setIsLoadingMore(true);\n try {\n await fetchNextPage();\n } finally {\n fetchingRef.current = false;\n }\n }\n }\n },\n [fetchNextPage, isLoading, isLoadingMore]\n );\n\n const handleScroll = useCallback(\n async (e: React.UIEvent<HTMLDivElement>) => {\n await fetchMoreOnEndReached(e.currentTarget);\n },\n [fetchMoreOnEndReached]\n );\n\n const rows = table.getRowModel().rows;\n const headerGroups = table.getHeaderGroups();\n const hasData = rows.length > 0;\n\n const hasEditableColumns = table\n .getAllColumns()\n .some((column) =>\n isColumnDeclaredEditable(column.columnDef.meta?.editable)\n );\n\n // Use pointerdown instead of click to detect outside interactions.\n // base-ui's Select renders a full-screen backdrop that intercepts\n // pointerdown to close the popup. By the time the click event fires,\n // the backdrop is unmounted and event.target falls through to <body>,\n // which would incorrectly trigger the outside-click handler.\n // At pointerdown time the backdrop is still in the DOM, so\n // portalTracker.containsElement correctly identifies it.\n useEffect(() => {\n const handleClickOutside = (event: PointerEvent) => {\n const target = event.target as Node;\n if (\n tableContainerRef.current &&\n !tableContainerRef.current.contains(target) &&\n !portalTracker?.containsElement(target)\n ) {\n setFocusedRowId(null);\n }\n };\n\n document.addEventListener(\"pointerdown\", handleClickOutside);\n return () => {\n document.removeEventListener(\"pointerdown\", handleClickOutside);\n };\n }, [portalTracker, setFocusedRowId]);\n\n return (\n <PortalContainerProvider container={objectTablePortalRef}>\n <div\n ref={objectTablePortalRef}\n className={classNames(styles.osdkTableWrapper, className)}\n >\n <div\n ref={tableContainerRef}\n className={styles.osdkTableContainer}\n onScroll={handleScroll}\n >\n <table>\n {isLoading && !hasData ? (\n <LoadingStateTable\n table={table}\n headerGroups={headerGroups}\n rowHeight={rowHeight}\n tableContainerRef={tableContainerRef}\n />\n ) : (\n <>\n <TableHeader\n table={table}\n headerMenuFeatureFlags={headerMenuFeatureFlags}\n onColumnHeaderClick={onColumnHeaderClick}\n />\n <TableBody\n rows={rows}\n tableContainerRef={tableContainerRef}\n onRowClick={onRowClick}\n rowHeight={rowHeight}\n renderCellContextMenu={renderCellContextMenu}\n isLoadingMore={isLoadingMore}\n headerGroups={headerGroups}\n focusedRowId={focusedRowId}\n setFocusedRowId={setFocusedRowId}\n isInEditMode={editableConfig?.editModeState.isActive}\n getRowAttributes={getRowAttributes}\n />\n </>\n )}\n </table>\n {!hasData &&\n error == null &&\n (renderEmptyState != null ? (\n renderEmptyState()\n ) : (\n <NonIdealState message={\"No Data\"} />\n ))}\n {error != null && (\n <NonIdealState message={`Error Loading Data: ${error.message}`} />\n )}\n </div>\n {showEditFooter && hasEditableColumns && editableConfig && (\n <TableEditContainer\n editableConfig={editableConfig}\n hasFocusedRow={focusedRowId != null}\n />\n )}\n </div>\n </PortalContainerProvider>\n );\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,OAAOA,UAAU,MAAM,YAAY;AACnC,OAAOC,KAAK,IAEVC,WAAW,EACXC,SAAS,EACTC,MAAM,EACNC,QAAQ,QACH,OAAO;AAEd,SAASC,uBAAuB,QAAQ,qCAAqC;AAC7E,SAASC,aAAa,QAAQ,0BAA0B;AACxD,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,aAAa,QAAQ,oBAAoB;AAClD,SAASC,SAAS,QAAQ,gBAAgB;AAC1C,SAASC,kBAAkB,QAAQ,yBAAyB;AAC5D,SAASC,WAAW,QAAQ,kBAAkB;AAE9C,SAASC,sBAAsB,QAAQ,sBAAsB;AAC7D,SAASC,wBAAwB,QAAQ,0BAA0B;AACnE,SACEC,qBAAqB,EACrBC,gBAAgB,QACX,0BAA0B;AAOjC,OAAOC,MAAM,MAAM,oBAAoB;AAsEvC,OAAO,SAASC,SAASA,CACvBC,KAA4B,EACd;EACd,oBACElB,KAAA,CAAAmB,aAAA,CAACL,qBAAqB,qBACpBd,KAAA,CAAAmB,aAAA,CAACC,cAAc,EAAKF,KAAQ,CACP,CAAC;AAE5B;AAEA,SAASE,cAAcA,CAAwB;EAC7CC,KAAK;EACLC,SAAS;EACTC,aAAa;EACbC,UAAU;EACVC,mBAAmB;EACnBC,SAAS;EACTC,qBAAqB;EACrBC,SAAS;EACTC,KAAK;EACLC,sBAAsB;EACtBC,cAAc;EACdC,gBAAgB;EAChBC,cAAc,GAAG,IAAI;EACrBC,gBAAgB;EAChBC,YAAY,EAAEC,gBAAgB;EAC9BC;AACqB,CAAC,EAAgB;EACtC,MAAMC,iBAAiB,GAAGnC,MAAM,CAAiB,IAAI,CAAC;EACtD,MAAMoC,oBAAoB,GAAGpC,MAAM,CAAiB,IAAI,CAAC;EACzD,MAAM,CAACqC,aAAa,EAAEC,gBAAgB,CAAC,GAAGrC,QAAQ,CAAC,KAAK,CAAC;EAEzD,MAAMsC,UAAU,GAAGzC,WAAW,CAC3B0C,EAAU,IAAK;IACd,IAAI;MACF,OAAOtB,KAAK,CAACuB,MAAM,CAACD,EAAE,EAAE,IAAI,CAAC,EAAEE,QAAQ,IAAI,IAAI;IACjD,CAAC,CAAC,MAAM;MACN;MACA;MACA;MACA,OAAO,IAAI;IACb;EACF,CAAC,EACD,CAACxB,KAAK,CACR,CAAC;EAED,MAAM;IAAEc,YAAY;IAAEW;EAAgB,CAAC,GAAGxC,aAAa,CAAQ;IAC7D6B,YAAY,EAAEC,gBAAgB;IAC9BC,mBAAmB;IACnBK;EACF,CAAC,CAAC;EACF,MAAMK,aAAa,GAAGhC,gBAAgB,CAAC,CAAC;;EAExC;EACA;EACA;EACA;EACA;EACA,IAAIM,KAAK,CAAC2B,OAAO,CAACC,IAAI,EAAE;IACtB5B,KAAK,CAAC2B,OAAO,CAACC,IAAI,CAACd,YAAY,GAAGA,YAAY;EAChD;;EAEA;EACA,MAAMe,WAAW,GAAG/C,MAAM,CAAC,KAAK,CAAC;EAEjCD,SAAS,CAAC,MAAM;IACd,IAAI,CAACoB,SAAS,IAAIC,aAAa,IAAI,IAAI,EAAE;MACvCkB,gBAAgB,CAAC,KAAK,CAAC;IACzB;EACF,CAAC,EAAE,CAACnB,SAAS,EAAEC,aAAa,CAAC,CAAC;EAE9B,MAAM4B,qBAAqB,GAAGlD,WAAW,CACvC,MAAOmD,mBAA2C,IAAK;IACrD,IAAIA,mBAAmB,IAAI,CAACF,WAAW,CAACG,OAAO,IAAI,CAACb,aAAa,EAAE;MACjE,MAAM;QAAEc,YAAY;QAAEC,SAAS;QAAEC;MAAa,CAAC,GAAGJ,mBAAmB;MACrE,IACEE,YAAY,GAAGC,SAAS,GAAGC,YAAY,GAAG5C,sBAAsB,IAChE,CAACU,SAAS,IACVC,aAAa,IAAI,IAAI,EACrB;QACA2B,WAAW,CAACG,OAAO,GAAG,IAAI;QAC1BZ,gBAAgB,CAAC,IAAI,CAAC;QACtB,IAAI;UACF,MAAMlB,aAAa,CAAC,CAAC;QACvB,CAAC,SAAS;UACR2B,WAAW,CAACG,OAAO,GAAG,KAAK;QAC7B;MACF;IACF;EACF,CAAC,EACD,CAAC9B,aAAa,EAAED,SAAS,EAAEkB,aAAa,CAC1C,CAAC;EAED,MAAMiB,YAAY,GAAGxD,WAAW,CAC9B,MAAOyD,CAAgC,IAAK;IAC1C,MAAMP,qBAAqB,CAACO,CAAC,CAACC,aAAa,CAAC;EAC9C,CAAC,EACD,CAACR,qBAAqB,CACxB,CAAC;EAED,MAAMS,IAAI,GAAGvC,KAAK,CAACwC,WAAW,CAAC,CAAC,CAACD,IAAI;EACrC,MAAME,YAAY,GAAGzC,KAAK,CAAC0C,eAAe,CAAC,CAAC;EAC5C,MAAMC,OAAO,GAAGJ,IAAI,CAACK,MAAM,GAAG,CAAC;EAE/B,MAAMC,kBAAkB,GAAG7C,KAAK,CAC7B8C,aAAa,CAAC,CAAC,CACfC,IAAI,CAAEC,MAAM,IACXxD,wBAAwB,CAACwD,MAAM,CAACC,SAAS,CAACrB,IAAI,EAAEsB,QAAQ,CAC1D,CAAC;;EAEH;EACA;EACA;EACA;EACA;EACA;EACA;EACArE,SAAS,CAAC,MAAM;IACd,MAAMsE,kBAAkB,GAAIC,KAAmB,IAAK;MAClD,MAAMC,MAAM,GAAGD,KAAK,CAACC,MAAc;MACnC,IACEpC,iBAAiB,CAACe,OAAO,IACzB,CAACf,iBAAiB,CAACe,OAAO,CAACsB,QAAQ,CAACD,MAAM,CAAC,IAC3C,CAAC3B,aAAa,EAAE6B,eAAe,CAACF,MAAM,CAAC,EACvC;QACA5B,eAAe,CAAC,IAAI,CAAC;MACvB;IACF,CAAC;IAED+B,QAAQ,CAACC,gBAAgB,CAAC,aAAa,EAAEN,kBAAkB,CAAC;IAC5D,OAAO,MAAM;MACXK,QAAQ,CAACE,mBAAmB,CAAC,aAAa,EAAEP,kBAAkB,CAAC;IACjE,CAAC;EACH,CAAC,EAAE,CAACzB,aAAa,EAAED,eAAe,CAAC,CAAC;EAEpC,oBACE9C,KAAA,CAAAmB,aAAA,CAACd,uBAAuB;IAAC2E,SAAS,EAAEzC;EAAqB,gBACvDvC,KAAA,CAAAmB,aAAA;IACE8D,GAAG,EAAE1C,oBAAqB;IAC1BX,SAAS,EAAE7B,UAAU,CAACiB,MAAM,CAACkE,gBAAgB,EAAEtD,SAAS;EAAE,gBAE1D5B,KAAA,CAAAmB,aAAA;IACE8D,GAAG,EAAE3C,iBAAkB;IACvBV,SAAS,EAAEZ,MAAM,CAACmE,kBAAmB;IACrCC,QAAQ,EAAE3B;EAAa,gBAEvBzD,KAAA,CAAAmB,aAAA,gBACGG,SAAS,IAAI,CAAC0C,OAAO,gBACpBhE,KAAA,CAAAmB,aAAA,CAACZ,iBAAiB;IAChBc,KAAK,EAAEA,KAAM;IACbyC,YAAY,EAAEA,YAAa;IAC3BpC,SAAS,EAAEA,SAAU;IACrBY,iBAAiB,EAAEA;EAAkB,CACtC,CAAC,gBAEFtC,KAAA,CAAAmB,aAAA,CAAAnB,KAAA,CAAAqF,QAAA,qBACErF,KAAA,CAAAmB,aAAA,CAACR,WAAW;IACVU,KAAK,EAAEA,KAAM;IACbS,sBAAsB,EAAEA,sBAAuB;IAC/CL,mBAAmB,EAAEA;EAAoB,CAC1C,CAAC,eACFzB,KAAA,CAAAmB,aAAA,CAACV,SAAS;IACRmD,IAAI,EAAEA,IAAK;IACXtB,iBAAiB,EAAEA,iBAAkB;IACrCd,UAAU,EAAEA,UAAW;IACvBE,SAAS,EAAEA,SAAU;IACrBC,qBAAqB,EAAEA,qBAAsB;IAC7Ca,aAAa,EAAEA,aAAc;IAC7BsB,YAAY,EAAEA,YAAa;IAC3B3B,YAAY,EAAEA,YAAa;IAC3BW,eAAe,EAAEA,eAAgB;IACjCwC,YAAY,EAAEvD,cAAc,EAAEwD,aAAa,CAACC,QAAS;IACrDxD,gBAAgB,EAAEA;EAAiB,CACpC,CACD,CAEC,CAAC,EACP,CAACgC,OAAO,IACPnC,KAAK,IAAI,IAAI,KACZK,gBAAgB,IAAI,IAAI,GACvBA,gBAAgB,CAAC,CAAC,gBAElBlC,KAAA,CAAAmB,aAAA,CAACX,aAAa;IAACiF,OAAO,EAAE;EAAU,CAAE,CACrC,CAAC,EACH5D,KAAK,IAAI,IAAI,iBACZ7B,KAAA,CAAAmB,aAAA,CAACX,aAAa;IAACiF,OAAO,EAAE,uBAAuB5D,KAAK,CAAC4D,OAAO;EAAG,CAAE,CAEhE,CAAC,EACLxD,cAAc,IAAIiC,kBAAkB,IAAInC,cAAc,iBACrD/B,KAAA,CAAAmB,aAAA,CAACT,kBAAkB;IACjBqB,cAAc,EAAEA,cAAe;IAC/B2D,aAAa,EAAEvD,YAAY,IAAI;EAAK,CACrC,CAEA,CACkB,CAAC;AAE9B","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"Table.js","names":["classNames","React","useCallback","useEffect","useRef","useState","PortalContainerProvider","useFocusedRow","LoadingStateTable","NonIdealState","ObjectTableLabelsProvider","useObjectTableLabels","TableBody","TableEditContainer","TableHeader","SCROLL_FETCH_THRESHOLD","isColumnDeclaredEditable","PortalTrackerProvider","usePortalTracker","styles","BaseTable","props","createElement","labels","BaseTableInner","table","isLoading","fetchNextPage","onRowClick","onColumnHeaderClick","rowHeight","renderCellContextMenu","className","error","headerMenuFeatureFlags","editableConfig","getRowAttributes","showEditFooter","renderEmptyState","focusedRowId","focusedRowIdProp","onFocusedRowChanged","tableContainerRef","objectTablePortalRef","isLoadingMore","setIsLoadingMore","getRowById","id","getRow","original","setFocusedRowId","portalTracker","options","meta","fetchingRef","fetchMoreOnEndReached","containerRefElement","current","scrollHeight","scrollTop","clientHeight","handleScroll","e","currentTarget","rows","getRowModel","headerGroups","getHeaderGroups","hasData","length","hasEditableColumns","getAllColumns","some","column","columnDef","editable","handleClickOutside","event","target","contains","containsElement","document","addEventListener","removeEventListener","container","ref","osdkTableWrapper","osdkTableContainer","onScroll","Fragment","isInEditMode","editModeState","isActive","message","noData","errorLoadingData","hasFocusedRow"],"sources":["Table.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { Cell, RowData, Table } from \"@tanstack/react-table\";\nimport classNames from \"classnames\";\nimport React, {\n type ReactElement,\n useCallback,\n useEffect,\n useRef,\n useState,\n} from \"react\";\n\nimport { PortalContainerProvider } from \"../shared/PortalContainerContext.js\";\nimport { useFocusedRow } from \"./hooks/useFocusedRow.js\";\nimport { LoadingStateTable } from \"./LoadingStateTable.js\";\nimport { NonIdealState } from \"./NonIdealState.js\";\nimport type { ObjectTableLabels } from \"./ObjectTableLabels.js\";\nimport {\n ObjectTableLabelsProvider,\n useObjectTableLabels,\n} from \"./ObjectTableLabels.js\";\nimport { TableBody } from \"./TableBody.js\";\nimport { TableEditContainer } from \"./TableEditContainer.js\";\nimport { TableHeader } from \"./TableHeader.js\";\nimport type { HeaderMenuFeatureFlags } from \"./TableHeaderWithPopover.js\";\nimport { SCROLL_FETCH_THRESHOLD } from \"./utils/constants.js\";\nimport { isColumnDeclaredEditable } from \"./utils/editableUtils.js\";\nimport {\n PortalTrackerProvider,\n usePortalTracker,\n} from \"./utils/PortalTracker.js\";\nimport type {\n CellEditInfo,\n EditableConfig,\n EditFieldConfig,\n} from \"./utils/types.js\";\n\nimport styles from \"./Table.module.css\";\n\ndeclare module \"@tanstack/react-table\" {\n interface ColumnMeta<TData extends RowData = unknown, TValue = unknown> {\n columnName?: string;\n isAsyncColumn?: boolean;\n isVisible?: boolean;\n editable?: boolean | ((object: TData) => boolean);\n dataType?: string;\n /**\n * For columns backed by a `\"marking\"` property, the marking subtype as\n * surfaced by the platform: `\"CBAC\"` for classification-based access\n * control or `\"MANDATORY\"` for mandatory markings. Absent for\n * non-marking columns and for marking columns whose subtype isn't\n * exposed.\n */\n markingType?: \"CBAC\" | \"MANDATORY\";\n editFieldConfig?: EditFieldConfig<TData>;\n validateEdit?: (value: unknown) => Promise<string | undefined>;\n }\n interface TableMeta<TData extends RowData = unknown> {\n onCellEdit?: (cellId: string, info: CellEditInfo<TData, unknown>) => void;\n onCellValidationError?: (cellId: string, error: string) => void;\n clearCellValidationError?: (cellId: string) => void;\n cellEdits?: Record<string, CellEditInfo<TData, unknown>>;\n isInEditMode?: boolean;\n validationErrors?: Map<string, string>;\n focusedRowId?: string | null;\n }\n}\n\nexport interface BaseTableProps<TData extends RowData> {\n table: Table<TData>;\n isLoading?: boolean;\n fetchNextPage?: () => Promise<void>;\n onRowClick?: (row: TData) => void;\n onColumnHeaderClick?: (columnId: string) => void;\n rowHeight?: number;\n renderCellContextMenu?: (\n row: TData,\n cell: Cell<TData, unknown>\n ) => React.ReactNode;\n className?: string;\n error?: Error;\n headerMenuFeatureFlags?: HeaderMenuFeatureFlags;\n editableConfig?: EditableConfig<TData, unknown>;\n getRowAttributes?: (object: TData) => Record<string, string | undefined>;\n /**\n * Whether to render the bottom edit footer. Defaults to `true`; the\n * footer is only rendered when the table has at least one editable\n * column (`hasEditableColumns`).\n */\n showEditFooter?: boolean;\n /**\n * Render override for the empty state. Called when the table has no\n * rows and no error. When omitted, a default \"No Data\" indicator is\n * rendered.\n */\n renderEmptyState?: () => React.ReactNode;\n /**\n * Controlled focused row id. `undefined` enables internal management\n */\n focusedRowId?: string | null;\n /**\n * Fires whenever the focused row changes, in both controlled and\n * uncontrolled modes.\n */\n onFocusedRowChanged?: (row: TData | null) => void;\n /**\n * Overrides for the table's user-facing strings. Provide any subset; unset\n * keys fall back to the built-in English defaults. See\n * {@link ObjectTableLabels}.\n */\n labels?: Partial<ObjectTableLabels>;\n}\n\nexport function BaseTable<TData extends RowData>(\n props: BaseTableProps<TData>\n): ReactElement {\n return (\n <ObjectTableLabelsProvider labels={props.labels}>\n <PortalTrackerProvider>\n <BaseTableInner {...props} />\n </PortalTrackerProvider>\n </ObjectTableLabelsProvider>\n );\n}\n\nfunction BaseTableInner<TData extends RowData>({\n table,\n isLoading,\n fetchNextPage,\n onRowClick,\n onColumnHeaderClick,\n rowHeight,\n renderCellContextMenu,\n className,\n error,\n headerMenuFeatureFlags,\n editableConfig,\n getRowAttributes,\n showEditFooter = true,\n renderEmptyState,\n focusedRowId: focusedRowIdProp,\n onFocusedRowChanged,\n}: BaseTableProps<TData>): ReactElement {\n const tableContainerRef = useRef<HTMLDivElement>(null);\n const objectTablePortalRef = useRef<HTMLDivElement>(null);\n const [isLoadingMore, setIsLoadingMore] = useState(false);\n const labels = useObjectTableLabels();\n\n const getRowById = useCallback(\n (id: string) => {\n try {\n return table.getRow(id, true)?.original ?? null;\n } catch {\n // table.getRow throws when the id no longer matches a row\n // (e.g. the row was removed or has not loaded yet). Treat a\n // missing row as \"no focus\" rather than crashing.\n return null;\n }\n },\n [table]\n );\n\n const { focusedRowId, setFocusedRowId } = useFocusedRow<TData>({\n focusedRowId: focusedRowIdProp,\n onFocusedRowChanged,\n getRowById,\n });\n const portalTracker = usePortalTracker();\n\n // Sync focusedRowId into table meta so cell renderers (which only\n // receive `table`) can read it without extra prop drilling.\n // Assigned synchronously so children see the current value in the\n // same render pass. This is safe because meta is a mutable bag that\n // TanStack Table never snapshots or shallow-compares.\n if (table.options.meta) {\n table.options.meta.focusedRowId = focusedRowId;\n }\n\n // Using a ref to prevent duplicate fetches from rapid scroll events while a fetch is in-flight\n const fetchingRef = useRef(false);\n\n useEffect(() => {\n if (!isLoading || fetchNextPage == null) {\n setIsLoadingMore(false);\n }\n }, [isLoading, fetchNextPage]);\n\n const fetchMoreOnEndReached = useCallback(\n async (containerRefElement?: HTMLDivElement | null) => {\n if (containerRefElement && !fetchingRef.current && !isLoadingMore) {\n const { scrollHeight, scrollTop, clientHeight } = containerRefElement;\n if (\n scrollHeight - scrollTop - clientHeight < SCROLL_FETCH_THRESHOLD &&\n !isLoading &&\n fetchNextPage != null\n ) {\n fetchingRef.current = true;\n setIsLoadingMore(true);\n try {\n await fetchNextPage();\n } finally {\n fetchingRef.current = false;\n }\n }\n }\n },\n [fetchNextPage, isLoading, isLoadingMore]\n );\n\n const handleScroll = useCallback(\n async (e: React.UIEvent<HTMLDivElement>) => {\n await fetchMoreOnEndReached(e.currentTarget);\n },\n [fetchMoreOnEndReached]\n );\n\n const rows = table.getRowModel().rows;\n const headerGroups = table.getHeaderGroups();\n const hasData = rows.length > 0;\n\n const hasEditableColumns = table\n .getAllColumns()\n .some((column) =>\n isColumnDeclaredEditable(column.columnDef.meta?.editable)\n );\n\n // Use pointerdown instead of click to detect outside interactions.\n // base-ui's Select renders a full-screen backdrop that intercepts\n // pointerdown to close the popup. By the time the click event fires,\n // the backdrop is unmounted and event.target falls through to <body>,\n // which would incorrectly trigger the outside-click handler.\n // At pointerdown time the backdrop is still in the DOM, so\n // portalTracker.containsElement correctly identifies it.\n useEffect(() => {\n const handleClickOutside = (event: PointerEvent) => {\n const target = event.target as Node;\n if (\n tableContainerRef.current &&\n !tableContainerRef.current.contains(target) &&\n !portalTracker?.containsElement(target)\n ) {\n setFocusedRowId(null);\n }\n };\n\n document.addEventListener(\"pointerdown\", handleClickOutside);\n return () => {\n document.removeEventListener(\"pointerdown\", handleClickOutside);\n };\n }, [portalTracker, setFocusedRowId]);\n\n return (\n <PortalContainerProvider container={objectTablePortalRef}>\n <div\n ref={objectTablePortalRef}\n className={classNames(styles.osdkTableWrapper, className)}\n >\n <div\n ref={tableContainerRef}\n className={styles.osdkTableContainer}\n onScroll={handleScroll}\n >\n <table>\n {isLoading && !hasData ? (\n <LoadingStateTable\n table={table}\n headerGroups={headerGroups}\n rowHeight={rowHeight}\n tableContainerRef={tableContainerRef}\n />\n ) : (\n <>\n <TableHeader\n table={table}\n headerMenuFeatureFlags={headerMenuFeatureFlags}\n onColumnHeaderClick={onColumnHeaderClick}\n />\n <TableBody\n rows={rows}\n tableContainerRef={tableContainerRef}\n onRowClick={onRowClick}\n rowHeight={rowHeight}\n renderCellContextMenu={renderCellContextMenu}\n isLoadingMore={isLoadingMore}\n headerGroups={headerGroups}\n focusedRowId={focusedRowId}\n setFocusedRowId={setFocusedRowId}\n isInEditMode={editableConfig?.editModeState.isActive}\n getRowAttributes={getRowAttributes}\n />\n </>\n )}\n </table>\n {!hasData &&\n error == null &&\n (renderEmptyState != null ? (\n renderEmptyState()\n ) : (\n <NonIdealState message={labels.noData} />\n ))}\n {error != null && (\n <NonIdealState message={labels.errorLoadingData(error.message)} />\n )}\n </div>\n {showEditFooter && hasEditableColumns && editableConfig && (\n <TableEditContainer\n editableConfig={editableConfig}\n hasFocusedRow={focusedRowId != null}\n />\n )}\n </div>\n </PortalContainerProvider>\n );\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,OAAOA,UAAU,MAAM,YAAY;AACnC,OAAOC,KAAK,IAEVC,WAAW,EACXC,SAAS,EACTC,MAAM,EACNC,QAAQ,QACH,OAAO;AAEd,SAASC,uBAAuB,QAAQ,qCAAqC;AAC7E,SAASC,aAAa,QAAQ,0BAA0B;AACxD,SAASC,iBAAiB,QAAQ,wBAAwB;AAC1D,SAASC,aAAa,QAAQ,oBAAoB;AAElD,SACEC,yBAAyB,EACzBC,oBAAoB,QACf,wBAAwB;AAC/B,SAASC,SAAS,QAAQ,gBAAgB;AAC1C,SAASC,kBAAkB,QAAQ,yBAAyB;AAC5D,SAASC,WAAW,QAAQ,kBAAkB;AAE9C,SAASC,sBAAsB,QAAQ,sBAAsB;AAC7D,SAASC,wBAAwB,QAAQ,0BAA0B;AACnE,SACEC,qBAAqB,EACrBC,gBAAgB,QACX,0BAA0B;AAOjC,OAAOC,MAAM,MAAM,oBAAoB;AA4EvC,OAAO,SAASC,SAASA,CACvBC,KAA4B,EACd;EACd,oBACEpB,KAAA,CAAAqB,aAAA,CAACZ,yBAAyB;IAACa,MAAM,EAAEF,KAAK,CAACE;EAAO,gBAC9CtB,KAAA,CAAAqB,aAAA,CAACL,qBAAqB,qBACpBhB,KAAA,CAAAqB,aAAA,CAACE,cAAc,EAAKH,KAAQ,CACP,CACE,CAAC;AAEhC;AAEA,SAASG,cAAcA,CAAwB;EAC7CC,KAAK;EACLC,SAAS;EACTC,aAAa;EACbC,UAAU;EACVC,mBAAmB;EACnBC,SAAS;EACTC,qBAAqB;EACrBC,SAAS;EACTC,KAAK;EACLC,sBAAsB;EACtBC,cAAc;EACdC,gBAAgB;EAChBC,cAAc,GAAG,IAAI;EACrBC,gBAAgB;EAChBC,YAAY,EAAEC,gBAAgB;EAC9BC;AACqB,CAAC,EAAgB;EACtC,MAAMC,iBAAiB,GAAGtC,MAAM,CAAiB,IAAI,CAAC;EACtD,MAAMuC,oBAAoB,GAAGvC,MAAM,CAAiB,IAAI,CAAC;EACzD,MAAM,CAACwC,aAAa,EAAEC,gBAAgB,CAAC,GAAGxC,QAAQ,CAAC,KAAK,CAAC;EACzD,MAAMkB,MAAM,GAAGZ,oBAAoB,CAAC,CAAC;EAErC,MAAMmC,UAAU,GAAG5C,WAAW,CAC3B6C,EAAU,IAAK;IACd,IAAI;MACF,OAAOtB,KAAK,CAACuB,MAAM,CAACD,EAAE,EAAE,IAAI,CAAC,EAAEE,QAAQ,IAAI,IAAI;IACjD,CAAC,CAAC,MAAM;MACN;MACA;MACA;MACA,OAAO,IAAI;IACb;EACF,CAAC,EACD,CAACxB,KAAK,CACR,CAAC;EAED,MAAM;IAAEc,YAAY;IAAEW;EAAgB,CAAC,GAAG3C,aAAa,CAAQ;IAC7DgC,YAAY,EAAEC,gBAAgB;IAC9BC,mBAAmB;IACnBK;EACF,CAAC,CAAC;EACF,MAAMK,aAAa,GAAGjC,gBAAgB,CAAC,CAAC;;EAExC;EACA;EACA;EACA;EACA;EACA,IAAIO,KAAK,CAAC2B,OAAO,CAACC,IAAI,EAAE;IACtB5B,KAAK,CAAC2B,OAAO,CAACC,IAAI,CAACd,YAAY,GAAGA,YAAY;EAChD;;EAEA;EACA,MAAMe,WAAW,GAAGlD,MAAM,CAAC,KAAK,CAAC;EAEjCD,SAAS,CAAC,MAAM;IACd,IAAI,CAACuB,SAAS,IAAIC,aAAa,IAAI,IAAI,EAAE;MACvCkB,gBAAgB,CAAC,KAAK,CAAC;IACzB;EACF,CAAC,EAAE,CAACnB,SAAS,EAAEC,aAAa,CAAC,CAAC;EAE9B,MAAM4B,qBAAqB,GAAGrD,WAAW,CACvC,MAAOsD,mBAA2C,IAAK;IACrD,IAAIA,mBAAmB,IAAI,CAACF,WAAW,CAACG,OAAO,IAAI,CAACb,aAAa,EAAE;MACjE,MAAM;QAAEc,YAAY;QAAEC,SAAS;QAAEC;MAAa,CAAC,GAAGJ,mBAAmB;MACrE,IACEE,YAAY,GAAGC,SAAS,GAAGC,YAAY,GAAG7C,sBAAsB,IAChE,CAACW,SAAS,IACVC,aAAa,IAAI,IAAI,EACrB;QACA2B,WAAW,CAACG,OAAO,GAAG,IAAI;QAC1BZ,gBAAgB,CAAC,IAAI,CAAC;QACtB,IAAI;UACF,MAAMlB,aAAa,CAAC,CAAC;QACvB,CAAC,SAAS;UACR2B,WAAW,CAACG,OAAO,GAAG,KAAK;QAC7B;MACF;IACF;EACF,CAAC,EACD,CAAC9B,aAAa,EAAED,SAAS,EAAEkB,aAAa,CAC1C,CAAC;EAED,MAAMiB,YAAY,GAAG3D,WAAW,CAC9B,MAAO4D,CAAgC,IAAK;IAC1C,MAAMP,qBAAqB,CAACO,CAAC,CAACC,aAAa,CAAC;EAC9C,CAAC,EACD,CAACR,qBAAqB,CACxB,CAAC;EAED,MAAMS,IAAI,GAAGvC,KAAK,CAACwC,WAAW,CAAC,CAAC,CAACD,IAAI;EACrC,MAAME,YAAY,GAAGzC,KAAK,CAAC0C,eAAe,CAAC,CAAC;EAC5C,MAAMC,OAAO,GAAGJ,IAAI,CAACK,MAAM,GAAG,CAAC;EAE/B,MAAMC,kBAAkB,GAAG7C,KAAK,CAC7B8C,aAAa,CAAC,CAAC,CACfC,IAAI,CAAEC,MAAM,IACXzD,wBAAwB,CAACyD,MAAM,CAACC,SAAS,CAACrB,IAAI,EAAEsB,QAAQ,CAC1D,CAAC;;EAEH;EACA;EACA;EACA;EACA;EACA;EACA;EACAxE,SAAS,CAAC,MAAM;IACd,MAAMyE,kBAAkB,GAAIC,KAAmB,IAAK;MAClD,MAAMC,MAAM,GAAGD,KAAK,CAACC,MAAc;MACnC,IACEpC,iBAAiB,CAACe,OAAO,IACzB,CAACf,iBAAiB,CAACe,OAAO,CAACsB,QAAQ,CAACD,MAAM,CAAC,IAC3C,CAAC3B,aAAa,EAAE6B,eAAe,CAACF,MAAM,CAAC,EACvC;QACA5B,eAAe,CAAC,IAAI,CAAC;MACvB;IACF,CAAC;IAED+B,QAAQ,CAACC,gBAAgB,CAAC,aAAa,EAAEN,kBAAkB,CAAC;IAC5D,OAAO,MAAM;MACXK,QAAQ,CAACE,mBAAmB,CAAC,aAAa,EAAEP,kBAAkB,CAAC;IACjE,CAAC;EACH,CAAC,EAAE,CAACzB,aAAa,EAAED,eAAe,CAAC,CAAC;EAEpC,oBACEjD,KAAA,CAAAqB,aAAA,CAAChB,uBAAuB;IAAC8E,SAAS,EAAEzC;EAAqB,gBACvD1C,KAAA,CAAAqB,aAAA;IACE+D,GAAG,EAAE1C,oBAAqB;IAC1BX,SAAS,EAAEhC,UAAU,CAACmB,MAAM,CAACmE,gBAAgB,EAAEtD,SAAS;EAAE,gBAE1D/B,KAAA,CAAAqB,aAAA;IACE+D,GAAG,EAAE3C,iBAAkB;IACvBV,SAAS,EAAEb,MAAM,CAACoE,kBAAmB;IACrCC,QAAQ,EAAE3B;EAAa,gBAEvB5D,KAAA,CAAAqB,aAAA,gBACGI,SAAS,IAAI,CAAC0C,OAAO,gBACpBnE,KAAA,CAAAqB,aAAA,CAACd,iBAAiB;IAChBiB,KAAK,EAAEA,KAAM;IACbyC,YAAY,EAAEA,YAAa;IAC3BpC,SAAS,EAAEA,SAAU;IACrBY,iBAAiB,EAAEA;EAAkB,CACtC,CAAC,gBAEFzC,KAAA,CAAAqB,aAAA,CAAArB,KAAA,CAAAwF,QAAA,qBACExF,KAAA,CAAAqB,aAAA,CAACR,WAAW;IACVW,KAAK,EAAEA,KAAM;IACbS,sBAAsB,EAAEA,sBAAuB;IAC/CL,mBAAmB,EAAEA;EAAoB,CAC1C,CAAC,eACF5B,KAAA,CAAAqB,aAAA,CAACV,SAAS;IACRoD,IAAI,EAAEA,IAAK;IACXtB,iBAAiB,EAAEA,iBAAkB;IACrCd,UAAU,EAAEA,UAAW;IACvBE,SAAS,EAAEA,SAAU;IACrBC,qBAAqB,EAAEA,qBAAsB;IAC7Ca,aAAa,EAAEA,aAAc;IAC7BsB,YAAY,EAAEA,YAAa;IAC3B3B,YAAY,EAAEA,YAAa;IAC3BW,eAAe,EAAEA,eAAgB;IACjCwC,YAAY,EAAEvD,cAAc,EAAEwD,aAAa,CAACC,QAAS;IACrDxD,gBAAgB,EAAEA;EAAiB,CACpC,CACD,CAEC,CAAC,EACP,CAACgC,OAAO,IACPnC,KAAK,IAAI,IAAI,KACZK,gBAAgB,IAAI,IAAI,GACvBA,gBAAgB,CAAC,CAAC,gBAElBrC,KAAA,CAAAqB,aAAA,CAACb,aAAa;IAACoF,OAAO,EAAEtE,MAAM,CAACuE;EAAO,CAAE,CACzC,CAAC,EACH7D,KAAK,IAAI,IAAI,iBACZhC,KAAA,CAAAqB,aAAA,CAACb,aAAa;IAACoF,OAAO,EAAEtE,MAAM,CAACwE,gBAAgB,CAAC9D,KAAK,CAAC4D,OAAO;EAAE,CAAE,CAEhE,CAAC,EACLxD,cAAc,IAAIiC,kBAAkB,IAAInC,cAAc,iBACrDlC,KAAA,CAAAqB,aAAA,CAACT,kBAAkB;IACjBsB,cAAc,EAAEA,cAAe;IAC/B6D,aAAa,EAAEzD,YAAY,IAAI;EAAK,CACrC,CAEA,CACkB,CAAC;AAE9B","ignoreList":[]}
|