@osdk/react-components 0.45.0 → 0.46.0
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/AGENTS.md +29 -29
- package/CHANGELOG.md +6 -0
- package/README.md +14 -14
- package/build/browser/document-viewer/DocumentViewer.js +6 -6
- package/build/browser/document-viewer/DocumentViewer.js.map +1 -1
- package/build/browser/document-viewer/DocumentViewerApi.js +1 -1
- package/build/browser/document-viewer/DocumentViewerApi.js.map +1 -1
- package/build/browser/object-table/ObjectTableApi.js.map +1 -1
- package/build/browser/public/experimental/{excel-viewer.js → spreadsheet-viewer.js} +6 -6
- package/build/browser/public/experimental/spreadsheet-viewer.js.map +1 -0
- package/build/browser/public/experimental.js +1 -1
- package/build/browser/public/experimental.js.map +1 -1
- package/build/{esm/excel-viewer/BaseExcelViewer.js → browser/spreadsheet-viewer/BaseSpreadsheetViewer.js} +3 -3
- package/build/browser/spreadsheet-viewer/BaseSpreadsheetViewer.js.map +1 -0
- package/build/{esm/excel-viewer/BaseExcelViewer.module.css → browser/spreadsheet-viewer/BaseSpreadsheetViewer.module.css} +33 -33
- package/build/browser/spreadsheet-viewer/BaseSpreadsheetViewer.module.css.js +20 -0
- package/build/browser/{excel-viewer/ExcelViewer.js → spreadsheet-viewer/SpreadsheetViewer.js} +7 -7
- package/build/browser/spreadsheet-viewer/SpreadsheetViewer.js.map +1 -0
- package/build/browser/spreadsheet-viewer/SpreadsheetViewerApi.js +2 -0
- package/build/browser/spreadsheet-viewer/SpreadsheetViewerApi.js.map +1 -0
- package/build/browser/spreadsheet-viewer/parseSpreadsheet.js.map +1 -0
- package/build/browser/styles.css +199 -197
- package/build/browser/tokens/component-tokens/spreadsheet-viewer.css +25 -0
- package/build/browser/tokens.css +1 -1
- package/build/browser/util/UserAgent.js +1 -1
- package/build/cjs/{ExcelViewerApi-D8tqiUvS.d.cts → SpreadsheetViewerApi-C4-gqkkY.d.cts} +4 -4
- package/build/cjs/{chunk-MG7UDVZR.cjs → chunk-2CKESSXH.cjs} +11 -11
- package/build/cjs/chunk-2CKESSXH.cjs.map +1 -0
- package/build/cjs/{chunk-GKDO6NU7.cjs → chunk-3C5JRKBJ.cjs} +30 -30
- package/build/cjs/chunk-3C5JRKBJ.cjs.map +1 -0
- package/build/cjs/{chunk-EIOTTIUV.cjs → chunk-A4PDCZUY.cjs} +4 -4
- package/build/cjs/{chunk-EIOTTIUV.cjs.map → chunk-A4PDCZUY.cjs.map} +1 -1
- package/build/cjs/{chunk-QQXBGYWP.cjs → chunk-AEQDZPU3.cjs} +4 -4
- package/build/cjs/{chunk-QQXBGYWP.cjs.map → chunk-AEQDZPU3.cjs.map} +1 -1
- package/build/cjs/{chunk-TVK2XLNJ.cjs → chunk-BLPXZKVC.cjs} +3 -3
- package/build/cjs/{chunk-TVK2XLNJ.cjs.map → chunk-BLPXZKVC.cjs.map} +1 -1
- package/build/cjs/chunk-D2NDALCM.cjs +11 -0
- package/build/cjs/chunk-D2NDALCM.cjs.map +1 -0
- package/build/cjs/chunk-I3KITN2A.cjs +11 -0
- package/build/cjs/{chunk-YCSU5IMD.cjs.map → chunk-I3KITN2A.cjs.map} +1 -1
- package/build/cjs/{chunk-T6SDOLIX.cjs → chunk-KGJWCRXE.cjs} +4 -4
- package/build/cjs/{chunk-T6SDOLIX.cjs.map → chunk-KGJWCRXE.cjs.map} +1 -1
- package/build/cjs/chunk-L4MQGDXA.cjs +11 -0
- package/build/cjs/{chunk-4VNSLY36.cjs.map → chunk-L4MQGDXA.cjs.map} +1 -1
- package/build/cjs/chunk-LS44RU72.cjs +11 -0
- package/build/cjs/{chunk-AU6YJLRT.cjs.map → chunk-LS44RU72.cjs.map} +1 -1
- package/build/cjs/{chunk-NER4ODIR.cjs → chunk-NK5S5G7V.cjs} +4 -4
- package/build/cjs/{chunk-NER4ODIR.cjs.map → chunk-NK5S5G7V.cjs.map} +1 -1
- package/build/cjs/chunk-T65VAHZ3.cjs +11 -0
- package/build/cjs/{chunk-KSCR5PCE.cjs.map → chunk-T65VAHZ3.cjs.map} +1 -1
- package/build/cjs/{chunk-WALOYQVH.cjs → chunk-UNK7YFKE.cjs} +4 -4
- package/build/cjs/{chunk-WALOYQVH.cjs.map → chunk-UNK7YFKE.cjs.map} +1 -1
- package/build/cjs/{chunk-7NPZBKYH.cjs → chunk-VMFLHUR7.cjs} +4 -4
- package/build/cjs/{chunk-7NPZBKYH.cjs.map → chunk-VMFLHUR7.cjs.map} +1 -1
- package/build/cjs/{chunk-KKRHM5JK.cjs → chunk-WMGFXPN6.cjs} +4 -4
- package/build/cjs/{chunk-KKRHM5JK.cjs.map → chunk-WMGFXPN6.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 +5 -5
- package/build/cjs/public/experimental/document-viewer.css +122 -122
- package/build/cjs/public/experimental/document-viewer.css.map +1 -1
- package/build/cjs/public/experimental/document-viewer.d.cts +5 -5
- package/build/cjs/public/experimental/email-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 +1 -1
- package/build/cjs/public/experimental/pdf-viewer.cjs +7 -7
- package/build/cjs/public/experimental/spreadsheet-viewer.cjs +20 -0
- package/build/cjs/public/experimental/spreadsheet-viewer.cjs.map +1 -0
- package/build/cjs/public/experimental/spreadsheet-viewer.css +122 -0
- package/build/cjs/public/experimental/spreadsheet-viewer.css.map +1 -0
- package/build/cjs/public/experimental/spreadsheet-viewer.d.cts +12 -0
- 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 +79 -79
- package/build/cjs/public/experimental.css +122 -122
- package/build/cjs/public/experimental.css.map +1 -1
- package/build/cjs/public/experimental.d.cts +2 -2
- package/build/esm/document-viewer/DocumentViewer.js +6 -6
- package/build/esm/document-viewer/DocumentViewer.js.map +1 -1
- package/build/esm/document-viewer/DocumentViewerApi.js +1 -1
- package/build/esm/document-viewer/DocumentViewerApi.js.map +1 -1
- package/build/esm/object-table/ObjectTableApi.js.map +1 -1
- package/build/esm/public/experimental/{excel-viewer.js → spreadsheet-viewer.js} +6 -6
- package/build/esm/public/experimental/spreadsheet-viewer.js.map +1 -0
- package/build/esm/public/experimental.js +1 -1
- package/build/esm/public/experimental.js.map +1 -1
- package/build/{browser/excel-viewer/BaseExcelViewer.js → esm/spreadsheet-viewer/BaseSpreadsheetViewer.js} +3 -3
- package/build/esm/spreadsheet-viewer/BaseSpreadsheetViewer.js.map +1 -0
- package/build/{browser/excel-viewer/BaseExcelViewer.module.css → esm/spreadsheet-viewer/BaseSpreadsheetViewer.module.css} +33 -33
- package/build/esm/{excel-viewer/ExcelViewer.js → spreadsheet-viewer/SpreadsheetViewer.js} +7 -7
- package/build/esm/spreadsheet-viewer/SpreadsheetViewer.js.map +1 -0
- package/build/esm/spreadsheet-viewer/SpreadsheetViewerApi.js +2 -0
- package/build/esm/spreadsheet-viewer/SpreadsheetViewerApi.js.map +1 -0
- package/build/esm/spreadsheet-viewer/parseSpreadsheet.js.map +1 -0
- package/build/esm/tokens/component-tokens/spreadsheet-viewer.css +25 -0
- package/build/esm/tokens.css +1 -1
- package/build/esm/util/UserAgent.js +1 -1
- package/build/types/document-viewer/DocumentViewer.d.ts +1 -1
- package/build/types/document-viewer/DocumentViewer.d.ts.map +1 -1
- package/build/types/document-viewer/DocumentViewerApi.d.ts +4 -4
- package/build/types/document-viewer/DocumentViewerApi.d.ts.map +1 -1
- package/build/types/object-table/ObjectTableApi.d.ts +1 -1
- package/build/types/public/experimental/spreadsheet-viewer.d.ts +4 -0
- package/build/types/public/experimental/spreadsheet-viewer.d.ts.map +1 -0
- package/build/types/public/experimental.d.ts +1 -1
- package/build/types/spreadsheet-viewer/BaseSpreadsheetViewer.d.ts +3 -0
- package/build/types/spreadsheet-viewer/BaseSpreadsheetViewer.d.ts.map +1 -0
- package/build/types/spreadsheet-viewer/SpreadsheetViewer.d.ts +3 -0
- package/build/types/spreadsheet-viewer/SpreadsheetViewer.d.ts.map +1 -0
- package/build/types/{excel-viewer/ExcelViewerApi.d.ts → spreadsheet-viewer/SpreadsheetViewerApi.d.ts} +3 -3
- package/build/types/spreadsheet-viewer/SpreadsheetViewerApi.d.ts.map +1 -0
- package/build/types/{excel-viewer → spreadsheet-viewer}/parseSpreadsheet.d.ts +1 -1
- package/build/types/spreadsheet-viewer/parseSpreadsheet.d.ts.map +1 -0
- package/docs/CSSVariables.md +25 -25
- package/docs/DocumentViewer.md +25 -25
- package/docs/ObjectTable.md +1 -1
- package/docs/{ExcelViewer.md → SpreadsheetViewer.md} +26 -24
- package/docs/Welcome.md +7 -7
- package/package.json +13 -13
- package/build/browser/excel-viewer/BaseExcelViewer.js.map +0 -1
- package/build/browser/excel-viewer/BaseExcelViewer.module.css.js +0 -20
- package/build/browser/excel-viewer/ExcelViewer.js.map +0 -1
- package/build/browser/excel-viewer/ExcelViewerApi.js +0 -2
- package/build/browser/excel-viewer/ExcelViewerApi.js.map +0 -1
- package/build/browser/excel-viewer/parseSpreadsheet.js.map +0 -1
- package/build/browser/public/experimental/excel-viewer.js.map +0 -1
- package/build/browser/tokens/component-tokens/excel-viewer.css +0 -23
- package/build/cjs/chunk-4VNSLY36.cjs +0 -11
- package/build/cjs/chunk-AU6YJLRT.cjs +0 -11
- package/build/cjs/chunk-GKDO6NU7.cjs.map +0 -1
- package/build/cjs/chunk-J4HBV3P2.cjs +0 -11
- package/build/cjs/chunk-J4HBV3P2.cjs.map +0 -1
- package/build/cjs/chunk-KSCR5PCE.cjs +0 -11
- package/build/cjs/chunk-MG7UDVZR.cjs.map +0 -1
- package/build/cjs/chunk-YCSU5IMD.cjs +0 -11
- package/build/cjs/public/experimental/excel-viewer.cjs +0 -20
- package/build/cjs/public/experimental/excel-viewer.cjs.map +0 -1
- package/build/cjs/public/experimental/excel-viewer.css +0 -122
- package/build/cjs/public/experimental/excel-viewer.css.map +0 -1
- package/build/cjs/public/experimental/excel-viewer.d.cts +0 -12
- package/build/esm/excel-viewer/BaseExcelViewer.js.map +0 -1
- package/build/esm/excel-viewer/ExcelViewer.js.map +0 -1
- package/build/esm/excel-viewer/ExcelViewerApi.js +0 -2
- package/build/esm/excel-viewer/ExcelViewerApi.js.map +0 -1
- package/build/esm/excel-viewer/parseSpreadsheet.js.map +0 -1
- package/build/esm/public/experimental/excel-viewer.js.map +0 -1
- package/build/esm/tokens/component-tokens/excel-viewer.css +0 -23
- package/build/types/excel-viewer/BaseExcelViewer.d.ts +0 -3
- package/build/types/excel-viewer/BaseExcelViewer.d.ts.map +0 -1
- package/build/types/excel-viewer/ExcelViewer.d.ts +0 -3
- package/build/types/excel-viewer/ExcelViewer.d.ts.map +0 -1
- package/build/types/excel-viewer/ExcelViewerApi.d.ts.map +0 -1
- package/build/types/excel-viewer/parseSpreadsheet.d.ts.map +0 -1
- package/build/types/public/experimental/excel-viewer.d.ts +0 -4
- package/build/types/public/experimental/excel-viewer.d.ts.map +0 -1
- /package/build/browser/{excel-viewer → spreadsheet-viewer}/parseSpreadsheet.js +0 -0
- /package/build/esm/{excel-viewer → spreadsheet-viewer}/parseSpreadsheet.js +0 -0
package/AGENTS.md
CHANGED
|
@@ -47,39 +47,39 @@ Components are imported from their individual entry points under `@osdk/react-co
|
|
|
47
47
|
- `@osdk/react-components/experimental/aip-agent-chat` — AipAgentChat, BaseAipAgentChat
|
|
48
48
|
- `@osdk/react-components/experimental/document-viewer` — DocumentViewer
|
|
49
49
|
- `@osdk/react-components/experimental/email-viewer` — EmailViewer, BaseEmailViewer
|
|
50
|
-
- `@osdk/react-components/experimental/
|
|
50
|
+
- `@osdk/react-components/experimental/spreadsheet-viewer` — SpreadsheetViewer, BaseSpreadsheetViewer
|
|
51
51
|
- `@osdk/react-components/experimental/image-viewer` — ImageViewer, BaseImageViewer
|
|
52
52
|
- `@osdk/react-components/experimental/video-viewer` — VideoViewer, BaseVideoViewer
|
|
53
53
|
- `@osdk/react-components/experimental/xml-viewer` — XmlViewer, BaseXmlViewer
|
|
54
54
|
|
|
55
|
-
| Component | Description
|
|
56
|
-
| -------------------------- |
|
|
57
|
-
| **ObjectTable** | Table for displaying OSDK object sets with sorting, filtering, inline editing, column pinning/resizing, row selection, and infinite scroll.
|
|
58
|
-
| **BaseTable** | OSDK-agnostic base table — use when building custom data fetching on top of the table UI.
|
|
59
|
-
| **FilterList** | Aggregation-based filter UI for object sets with draggable reordering.
|
|
60
|
-
| **BaseFilterList** | OSDK-agnostic base filter list — use for custom filter implementations.
|
|
61
|
-
| **ActionForm** | Form for applying OSDK actions with generated or custom field definitions.
|
|
62
|
-
| **BaseForm** | OSDK-agnostic base action form — use when supplying explicit field content and submit handling.
|
|
63
|
-
| **ColumnConfigDialog** | Dialog for managing column visibility and drag-and-drop reordering.
|
|
64
|
-
| **PdfViewer** | PDF viewer for OSDK Media objects with toolbar, search, annotations, sidebar (thumbnails/outline), highlight mode, and form fields.
|
|
65
|
-
| **BasePdfViewer** | OSDK-agnostic base PDF viewer — accepts a URL or ArrayBuffer directly. Use when building custom data fetching on top of the viewer UI.
|
|
66
|
-
| **TiffRenderer** | TIFF image renderer — accepts a `Uint8Array` and renders onto a canvas with size validation and error handling.
|
|
67
|
-
| **MarkdownRenderer** | Markdown renderer that accepts a markdown string and renders it with styled headings, code blocks, tables, and links.
|
|
68
|
-
| **AipAgentChat** | Chat surface backed by Foundry LMS via `useChat`. Takes a `PlatformClient` + model API name and renders messages, composer, and streaming.
|
|
69
|
-
| **BaseAipAgentChat** | OSDK-agnostic base chat — accepts `messages`/`status`/`onSendMessage` directly. Use for custom chat-state plumbing.
|
|
70
|
-
| **DocumentViewer** | Unified media viewer that auto-detects file type (PDF, TIFF, image, video,
|
|
71
|
-
| **EmailViewer** | Email viewer — parses and renders `.eml` files with headers, HTML body (sandboxed iframe), and plain text fallback.
|
|
72
|
-
| **
|
|
73
|
-
| **ImageViewer** | Image viewer — renders images (PNG, JPEG, GIF, SVG, WebP, BMP) with object-fit contain.
|
|
74
|
-
| **VideoViewer** | Video viewer — renders video with native browser controls.
|
|
75
|
-
| **XmlViewer** | XML viewer — renders XML content with syntax preservation.
|
|
76
|
-
| **CbacPicker** | Picker for classification-based access control (CBAC) markings — disjunctive/conjunctive categories, restriction enforcement, banner.
|
|
77
|
-
| **CbacPickerDialog** | Dialog wrapper for `CbacPicker` with confirm/cancel actions and validation.
|
|
78
|
-
| **CbacBanner** | OSDK-aware classification banner that resolves a marking-set into a colored banner.
|
|
79
|
-
| **BaseCbacPicker** | OSDK-agnostic base CBAC picker — use when building custom data fetching on top of the picker UI.
|
|
80
|
-
| **BaseCbacBanner** | OSDK-agnostic classification banner display with customizable colors and text.
|
|
81
|
-
| **BaseCbacPickerDialog** | OSDK-agnostic dialog wrapper for `BaseCbacPicker`.
|
|
82
|
-
| **MaxClassificationField** | Field that lets users constrain the maximum classification allowed for a marking selection.
|
|
55
|
+
| Component | Description |
|
|
56
|
+
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
57
|
+
| **ObjectTable** | Table for displaying OSDK object sets with sorting, filtering, inline editing, column pinning/resizing, row selection, and infinite scroll. |
|
|
58
|
+
| **BaseTable** | OSDK-agnostic base table — use when building custom data fetching on top of the table UI. |
|
|
59
|
+
| **FilterList** | Aggregation-based filter UI for object sets with draggable reordering. |
|
|
60
|
+
| **BaseFilterList** | OSDK-agnostic base filter list — use for custom filter implementations. |
|
|
61
|
+
| **ActionForm** | Form for applying OSDK actions with generated or custom field definitions. |
|
|
62
|
+
| **BaseForm** | OSDK-agnostic base action form — use when supplying explicit field content and submit handling. |
|
|
63
|
+
| **ColumnConfigDialog** | Dialog for managing column visibility and drag-and-drop reordering. |
|
|
64
|
+
| **PdfViewer** | PDF viewer for OSDK Media objects with toolbar, search, annotations, sidebar (thumbnails/outline), highlight mode, and form fields. |
|
|
65
|
+
| **BasePdfViewer** | OSDK-agnostic base PDF viewer — accepts a URL or ArrayBuffer directly. Use when building custom data fetching on top of the viewer UI. |
|
|
66
|
+
| **TiffRenderer** | TIFF image renderer — accepts a `Uint8Array` and renders onto a canvas with size validation and error handling. |
|
|
67
|
+
| **MarkdownRenderer** | Markdown renderer that accepts a markdown string and renders it with styled headings, code blocks, tables, and links. |
|
|
68
|
+
| **AipAgentChat** | Chat surface backed by Foundry LMS via `useChat`. Takes a `PlatformClient` + model API name and renders messages, composer, and streaming. |
|
|
69
|
+
| **BaseAipAgentChat** | OSDK-agnostic base chat — accepts `messages`/`status`/`onSendMessage` directly. Use for custom chat-state plumbing. |
|
|
70
|
+
| **DocumentViewer** | Unified media viewer that auto-detects file type (PDF, TIFF, image, video, spreadsheet, email, markdown, XML) and renders the appropriate viewer. |
|
|
71
|
+
| **EmailViewer** | Email viewer — parses and renders `.eml` files with headers, HTML body (sandboxed iframe), and plain text fallback. |
|
|
72
|
+
| **SpreadsheetViewer** | Spreadsheet viewer — parses and renders `.xlsx` spreadsheets with sheet tabs and column/row headers. |
|
|
73
|
+
| **ImageViewer** | Image viewer — renders images (PNG, JPEG, GIF, SVG, WebP, BMP) with object-fit contain. |
|
|
74
|
+
| **VideoViewer** | Video viewer — renders video with native browser controls. |
|
|
75
|
+
| **XmlViewer** | XML viewer — renders XML content with syntax preservation. |
|
|
76
|
+
| **CbacPicker** | Picker for classification-based access control (CBAC) markings — disjunctive/conjunctive categories, restriction enforcement, banner. |
|
|
77
|
+
| **CbacPickerDialog** | Dialog wrapper for `CbacPicker` with confirm/cancel actions and validation. |
|
|
78
|
+
| **CbacBanner** | OSDK-aware classification banner that resolves a marking-set into a colored banner. |
|
|
79
|
+
| **BaseCbacPicker** | OSDK-agnostic base CBAC picker — use when building custom data fetching on top of the picker UI. |
|
|
80
|
+
| **BaseCbacBanner** | OSDK-agnostic classification banner display with customizable colors and text. |
|
|
81
|
+
| **BaseCbacPickerDialog** | OSDK-agnostic dialog wrapper for `BaseCbacPicker`. |
|
|
82
|
+
| **MaxClassificationField** | Field that lets users constrain the maximum classification allowed for a marking selection. |
|
|
83
83
|
|
|
84
84
|
## Documentation
|
|
85
85
|
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# @osdk/react-components
|
|
2
2
|
|
|
3
|
+
## 0.46.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- c64be50: Rename `ExcelViewer` to `SpreadsheetViewer`. Breaking: the `experimental/excel-viewer` subpath is now `experimental/spreadsheet-viewer`, `ExcelViewer`/`BaseExcelViewer` and their prop types are renamed, `DocumentViewer`'s `excelViewerProps` is now `spreadsheetViewerProps`, `ViewerType.Excel` is now `ViewerType.Spreadsheet` and its value changed from `"excel"` to `"spreadsheet"`, and the `--osdk-excel-viewer-*` CSS tokens are now `--osdk-spreadsheet-viewer-*`. No deprecated aliases are kept.
|
|
8
|
+
|
|
3
9
|
## 0.45.0
|
|
4
10
|
|
|
5
11
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -126,20 +126,20 @@ Add `isolation: isolate` to your app's root element. This is required for Base U
|
|
|
126
126
|
|
|
127
127
|
The components that this package will provide are:
|
|
128
128
|
|
|
129
|
-
| Component
|
|
130
|
-
|
|
|
131
|
-
| `ObjectTable`
|
|
132
|
-
| `PdfViewer`
|
|
133
|
-
| `FilterList`
|
|
134
|
-
| `ActionForm`
|
|
135
|
-
| `AipAgentChat`
|
|
136
|
-
| `DocumentViewer`
|
|
137
|
-
| `EmailViewer`
|
|
138
|
-
| `
|
|
139
|
-
| `ImageViewer`
|
|
140
|
-
| `VideoViewer`
|
|
141
|
-
| `XmlViewer`
|
|
142
|
-
| `CbacPicker`
|
|
129
|
+
| Component | Description | Documentation |
|
|
130
|
+
| ------------------- | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
131
|
+
| `ObjectTable` | Displays an Object Set as a sortable, paginated table with inline editing support | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/ObjectTable.md) |
|
|
132
|
+
| `PdfViewer` | Renders PDF documents with annotations, search, sidebar navigation, and zoom | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/PdfViewer.md) |
|
|
133
|
+
| `FilterList` | Visualize a high-level summary of objects data to allow users to filter that data. | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/FilterList.md) |
|
|
134
|
+
| `ActionForm` | Auto-generated form for executing Ontology Actions | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/ActionForm.md) |
|
|
135
|
+
| `AipAgentChat` | Chat surface backed by Foundry LMS via `useChat` — takes a `PlatformClient` and model API name. | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/AipAgentChat.md) |
|
|
136
|
+
| `DocumentViewer` | Unified media viewer that auto-detects file type and renders the appropriate viewer | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/DocumentViewer.md) |
|
|
137
|
+
| `EmailViewer` | Parses and renders EML files with headers and sandboxed HTML body | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/EmailViewer.md) |
|
|
138
|
+
| `SpreadsheetViewer` | Renders spreadsheets (.xlsx) with sheet tabs and column/row headers | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/SpreadsheetViewer.md) |
|
|
139
|
+
| `ImageViewer` | Renders images (PNG, JPEG, GIF, SVG, WebP, BMP) | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/ImageViewer.md) |
|
|
140
|
+
| `VideoViewer` | Renders video with native browser controls | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/VideoViewer.md) |
|
|
141
|
+
| `XmlViewer` | Renders XML content with syntax preservation | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/XmlViewer.md) |
|
|
142
|
+
| `CbacPicker` | Picker for classification-based access control (CBAC) markings with banner display | [Guide](https://github.com/palantir/osdk-ts/blob/main/packages/react-components/docs/CbacPicker.md) |
|
|
143
143
|
|
|
144
144
|
## Component Architecture
|
|
145
145
|
|
|
@@ -21,12 +21,12 @@ import { Document as DocumentIcon } from "@blueprintjs/icons";
|
|
|
21
21
|
import classnames from "classnames";
|
|
22
22
|
import React, { useMemo } from "react";
|
|
23
23
|
import { EmailViewer } from "../email-viewer/EmailViewer.js";
|
|
24
|
-
import { ExcelViewer } from "../excel-viewer/ExcelViewer.js";
|
|
25
24
|
import { ImageViewer } from "../images/image-viewer/ImageViewer.js";
|
|
26
25
|
import { TiffViewerMedia } from "../images/tiff-renderer/TiffViewerMedia.js";
|
|
27
26
|
import { MarkdownViewerMedia } from "../markdown-renderer/MarkdownViewerMedia.js";
|
|
28
27
|
import { PdfViewer } from "../pdf-viewer/PdfRenderer.js";
|
|
29
28
|
import { assertUnreachable } from "../shared/assertUnreachable.js";
|
|
29
|
+
import { SpreadsheetViewer } from "../spreadsheet-viewer/SpreadsheetViewer.js";
|
|
30
30
|
import { VideoViewer } from "../video-viewer/VideoViewer.js";
|
|
31
31
|
import { XmlViewer } from "../xml-viewer/XmlViewer.js";
|
|
32
32
|
import { ViewerType } from "./DocumentViewerApi.js";
|
|
@@ -59,7 +59,7 @@ function getViewerType(mimeType, fileName) {
|
|
|
59
59
|
return ViewerType.Markdown;
|
|
60
60
|
}
|
|
61
61
|
if (mimeType === "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") {
|
|
62
|
-
return ViewerType.
|
|
62
|
+
return ViewerType.Spreadsheet;
|
|
63
63
|
}
|
|
64
64
|
if (mimeType === "message/rfc822") {
|
|
65
65
|
return ViewerType.Email;
|
|
@@ -78,7 +78,7 @@ export function DocumentViewer({
|
|
|
78
78
|
videoViewerProps,
|
|
79
79
|
tiffRendererProps,
|
|
80
80
|
markdownRendererProps,
|
|
81
|
-
|
|
81
|
+
spreadsheetViewerProps,
|
|
82
82
|
emailViewerProps,
|
|
83
83
|
xmlViewerProps,
|
|
84
84
|
fileName,
|
|
@@ -122,11 +122,11 @@ export function DocumentViewer({
|
|
|
122
122
|
media: media,
|
|
123
123
|
className: rootClassName
|
|
124
124
|
}, markdownRendererProps));
|
|
125
|
-
case ViewerType.
|
|
126
|
-
return /*#__PURE__*/React.createElement(
|
|
125
|
+
case ViewerType.Spreadsheet:
|
|
126
|
+
return /*#__PURE__*/React.createElement(SpreadsheetViewer, _extends({
|
|
127
127
|
media: media,
|
|
128
128
|
className: rootClassName
|
|
129
|
-
},
|
|
129
|
+
}, spreadsheetViewerProps));
|
|
130
130
|
case ViewerType.Email:
|
|
131
131
|
return /*#__PURE__*/React.createElement(EmailViewer, _extends({
|
|
132
132
|
media: media,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DocumentViewer.js","names":["Document","DocumentIcon","classnames","React","useMemo","EmailViewer","ExcelViewer","ImageViewer","TiffViewerMedia","MarkdownViewerMedia","PdfViewer","assertUnreachable","VideoViewer","XmlViewer","ViewerType","TiffDocumentViewer","styles","IMAGE_MIME_TYPES","Set","MARKDOWN_MIME_TYPES","XML_MIME_TYPES","isTiffFile","mimeType","fileName","lowered","toLowerCase","endsWith","getViewerType","Pdf","Tiff","has","Image","startsWith","Video","Markdown","Excel","Email","Xml","Unsupported","DocumentViewer","media","className","mimeTypeOverride","pdfViewerProps","imageViewerProps","videoViewerProps","tiffRendererProps","markdownRendererProps","excelViewerProps","emailViewerProps","xmlViewerProps","enableTiffToPdf","getMediaReference","viewerType","rootClassName","container","createElement","_extends","unsupportedContainer","unsupportedIcon"],"sources":["DocumentViewer.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\n/* cspell:words openxmlformats officedocument wordprocessingml spreadsheetml */\n\nimport { Document as DocumentIcon } from \"@blueprintjs/icons\";\nimport classnames from \"classnames\";\nimport React, { useMemo } from \"react\";\n\nimport { EmailViewer } from \"../email-viewer/EmailViewer.js\";\nimport { ExcelViewer } from \"../excel-viewer/ExcelViewer.js\";\nimport { ImageViewer } from \"../images/image-viewer/ImageViewer.js\";\nimport { TiffViewerMedia } from \"../images/tiff-renderer/TiffViewerMedia.js\";\nimport { MarkdownViewerMedia } from \"../markdown-renderer/MarkdownViewerMedia.js\";\nimport { PdfViewer } from \"../pdf-viewer/PdfRenderer.js\";\nimport { assertUnreachable } from \"../shared/assertUnreachable.js\";\nimport { VideoViewer } from \"../video-viewer/VideoViewer.js\";\nimport { XmlViewer } from \"../xml-viewer/XmlViewer.js\";\nimport type { DocumentViewerProps } from \"./DocumentViewerApi.js\";\nimport { ViewerType } from \"./DocumentViewerApi.js\";\nimport { TiffDocumentViewer } from \"./TiffDocumentViewer.js\";\n\nimport styles from \"./DocumentViewer.module.css\";\n\nconst IMAGE_MIME_TYPES = new Set([\n \"image/png\",\n \"image/jpeg\",\n \"image/gif\",\n \"image/svg+xml\",\n \"image/webp\",\n \"image/bmp\",\n]);\n\nconst MARKDOWN_MIME_TYPES = new Set([\"text/markdown\", \"text/x-markdown\"]);\n\nconst XML_MIME_TYPES = new Set([\"application/xml\", \"text/xml\"]);\n\nfunction isTiffFile(mimeType: string, fileName: string | undefined): boolean {\n if (mimeType === \"image/tiff\") {\n return true;\n }\n const lowered = fileName?.toLowerCase();\n return (\n lowered?.endsWith(\".tif\") === true || lowered?.endsWith(\".tiff\") === true\n );\n}\n\nfunction getViewerType(\n mimeType: string,\n fileName: string | undefined,\n): ViewerType {\n if (mimeType === \"application/pdf\") {\n return ViewerType.Pdf;\n }\n if (isTiffFile(mimeType, fileName)) {\n return ViewerType.Tiff;\n }\n if (IMAGE_MIME_TYPES.has(mimeType)) {\n return ViewerType.Image;\n }\n if (mimeType.startsWith(\"video/\")) {\n return ViewerType.Video;\n }\n if (MARKDOWN_MIME_TYPES.has(mimeType)) {\n return ViewerType.Markdown;\n }\n if (\n mimeType ===\n \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\"\n ) {\n return ViewerType.Excel;\n }\n if (mimeType === \"message/rfc822\") {\n return ViewerType.Email;\n }\n if (XML_MIME_TYPES.has(mimeType)) {\n return ViewerType.Xml;\n }\n return ViewerType.Unsupported;\n}\n\nexport function DocumentViewer({\n media,\n className,\n mimeTypeOverride,\n pdfViewerProps,\n imageViewerProps,\n videoViewerProps,\n tiffRendererProps,\n markdownRendererProps,\n excelViewerProps,\n emailViewerProps,\n xmlViewerProps,\n fileName,\n enableTiffToPdf = false,\n}: DocumentViewerProps): React.ReactElement {\n const mimeType = mimeTypeOverride ?? media.getMediaReference().mimeType;\n const viewerType = useMemo(\n () => getViewerType(mimeType, fileName),\n [mimeType, fileName],\n );\n const rootClassName = classnames(styles.container, className);\n\n switch (viewerType) {\n case ViewerType.Pdf:\n return (\n <PdfViewer\n media={media}\n className={rootClassName}\n {...pdfViewerProps}\n />\n );\n case ViewerType.Tiff:\n if (enableTiffToPdf) {\n return (\n <TiffDocumentViewer\n media={media}\n className={rootClassName}\n enableTiffToPdf={enableTiffToPdf}\n tiffRendererProps={tiffRendererProps}\n pdfViewerProps={pdfViewerProps}\n />\n );\n }\n return (\n <TiffViewerMedia\n media={media}\n className={rootClassName}\n {...tiffRendererProps}\n />\n );\n case ViewerType.Image:\n return (\n <ImageViewer\n media={media}\n className={rootClassName}\n {...imageViewerProps}\n />\n );\n case ViewerType.Video:\n return (\n <VideoViewer\n media={media}\n className={rootClassName}\n {...videoViewerProps}\n />\n );\n case ViewerType.Markdown:\n return (\n <MarkdownViewerMedia\n media={media}\n className={rootClassName}\n {...markdownRendererProps}\n />\n );\n case ViewerType.Excel:\n return (\n <ExcelViewer\n media={media}\n className={rootClassName}\n {...excelViewerProps}\n />\n );\n case ViewerType.Email:\n return (\n <EmailViewer\n media={media}\n className={rootClassName}\n {...emailViewerProps}\n />\n );\n case ViewerType.Xml:\n return (\n <XmlViewer\n media={media}\n className={rootClassName}\n {...xmlViewerProps}\n />\n );\n case ViewerType.Unsupported:\n return (\n <div className={rootClassName}>\n <div className={styles.unsupportedContainer}>\n <DocumentIcon className={styles.unsupportedIcon} />\n Unsupported file type: {mimeType}\n </div>\n </div>\n );\n default:\n assertUnreachable(viewerType);\n }\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;;AAEA,SAASA,QAAQ,IAAIC,YAAY,QAAQ,oBAAoB;AAC7D,OAAOC,UAAU,MAAM,YAAY;AACnC,OAAOC,KAAK,IAAIC,OAAO,QAAQ,OAAO;AAEtC,SAASC,WAAW,QAAQ,gCAAgC;AAC5D,SAASC,WAAW,QAAQ,gCAAgC;AAC5D,SAASC,WAAW,QAAQ,uCAAuC;AACnE,SAASC,eAAe,QAAQ,4CAA4C;AAC5E,SAASC,mBAAmB,QAAQ,6CAA6C;AACjF,SAASC,SAAS,QAAQ,8BAA8B;AACxD,SAASC,iBAAiB,QAAQ,gCAAgC;AAClE,SAASC,WAAW,QAAQ,gCAAgC;AAC5D,SAASC,SAAS,QAAQ,4BAA4B;AAEtD,SAASC,UAAU,QAAQ,wBAAwB;AACnD,SAASC,kBAAkB,QAAQ,yBAAyB;AAE5D,OAAOC,MAAM,MAAM,6BAA6B;AAEhD,MAAMC,gBAAgB,GAAG,IAAIC,GAAG,CAAC,CAC/B,WAAW,EACX,YAAY,EACZ,WAAW,EACX,eAAe,EACf,YAAY,EACZ,WAAW,CACZ,CAAC;AAEF,MAAMC,mBAAmB,GAAG,IAAID,GAAG,CAAC,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;AAEzE,MAAME,cAAc,GAAG,IAAIF,GAAG,CAAC,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC;AAE/D,SAASG,UAAUA,CAACC,QAAgB,EAAEC,QAA4B,EAAW;EAC3E,IAAID,QAAQ,KAAK,YAAY,EAAE;IAC7B,OAAO,IAAI;EACb;EACA,MAAME,OAAO,GAAGD,QAAQ,EAAEE,WAAW,CAAC,CAAC;EACvC,OACED,OAAO,EAAEE,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,IAAIF,OAAO,EAAEE,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI;AAE7E;AAEA,SAASC,aAAaA,CACpBL,QAAgB,EAChBC,QAA4B,EAChB;EACZ,IAAID,QAAQ,KAAK,iBAAiB,EAAE;IAClC,OAAOR,UAAU,CAACc,GAAG;EACvB;EACA,IAAIP,UAAU,CAACC,QAAQ,EAAEC,QAAQ,CAAC,EAAE;IAClC,OAAOT,UAAU,CAACe,IAAI;EACxB;EACA,IAAIZ,gBAAgB,CAACa,GAAG,CAACR,QAAQ,CAAC,EAAE;IAClC,OAAOR,UAAU,CAACiB,KAAK;EACzB;EACA,IAAIT,QAAQ,CAACU,UAAU,CAAC,QAAQ,CAAC,EAAE;IACjC,OAAOlB,UAAU,CAACmB,KAAK;EACzB;EACA,IAAId,mBAAmB,CAACW,GAAG,CAACR,QAAQ,CAAC,EAAE;IACrC,OAAOR,UAAU,CAACoB,QAAQ;EAC5B;EACA,IACEZ,QAAQ,KACR,mEAAmE,EACnE;IACA,OAAOR,UAAU,CAACqB,KAAK;EACzB;EACA,IAAIb,QAAQ,KAAK,gBAAgB,EAAE;IACjC,OAAOR,UAAU,CAACsB,KAAK;EACzB;EACA,IAAIhB,cAAc,CAACU,GAAG,CAACR,QAAQ,CAAC,EAAE;IAChC,OAAOR,UAAU,CAACuB,GAAG;EACvB;EACA,OAAOvB,UAAU,CAACwB,WAAW;AAC/B;AAEA,OAAO,SAASC,cAAcA,CAAC;EAC7BC,KAAK;EACLC,SAAS;EACTC,gBAAgB;EAChBC,cAAc;EACdC,gBAAgB;EAChBC,gBAAgB;EAChBC,iBAAiB;EACjBC,qBAAqB;EACrBC,gBAAgB;EAChBC,gBAAgB;EAChBC,cAAc;EACd3B,QAAQ;EACR4B,eAAe,GAAG;AACC,CAAC,EAAsB;EAC1C,MAAM7B,QAAQ,GAAGoB,gBAAgB,IAAIF,KAAK,CAACY,iBAAiB,CAAC,CAAC,CAAC9B,QAAQ;EACvE,MAAM+B,UAAU,GAAGjD,OAAO,CACxB,MAAMuB,aAAa,CAACL,QAAQ,EAAEC,QAAQ,CAAC,EACvC,CAACD,QAAQ,EAAEC,QAAQ,CACrB,CAAC;EACD,MAAM+B,aAAa,GAAGpD,UAAU,CAACc,MAAM,CAACuC,SAAS,EAAEd,SAAS,CAAC;EAE7D,QAAQY,UAAU;IAChB,KAAKvC,UAAU,CAACc,GAAG;MACjB,oBACEzB,KAAA,CAAAqD,aAAA,CAAC9C,SAAS,EAAA+C,QAAA;QACRjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBX,cAAc,CACnB,CAAC;IAEN,KAAK7B,UAAU,CAACe,IAAI;MAClB,IAAIsB,eAAe,EAAE;QACnB,oBACEhD,KAAA,CAAAqD,aAAA,CAACzC,kBAAkB;UACjByB,KAAK,EAAEA,KAAM;UACbC,SAAS,EAAEa,aAAc;UACzBH,eAAe,EAAEA,eAAgB;UACjCL,iBAAiB,EAAEA,iBAAkB;UACrCH,cAAc,EAAEA;QAAe,CAChC,CAAC;MAEN;MACA,oBACExC,KAAA,CAAAqD,aAAA,CAAChD,eAAe,EAAAiD,QAAA;QACdjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBR,iBAAiB,CACtB,CAAC;IAEN,KAAKhC,UAAU,CAACiB,KAAK;MACnB,oBACE5B,KAAA,CAAAqD,aAAA,CAACjD,WAAW,EAAAkD,QAAA;QACVjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBV,gBAAgB,CACrB,CAAC;IAEN,KAAK9B,UAAU,CAACmB,KAAK;MACnB,oBACE9B,KAAA,CAAAqD,aAAA,CAAC5C,WAAW,EAAA6C,QAAA;QACVjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBT,gBAAgB,CACrB,CAAC;IAEN,KAAK/B,UAAU,CAACoB,QAAQ;MACtB,oBACE/B,KAAA,CAAAqD,aAAA,CAAC/C,mBAAmB,EAAAgD,QAAA;QAClBjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBP,qBAAqB,CAC1B,CAAC;IAEN,KAAKjC,UAAU,CAACqB,KAAK;MACnB,oBACEhC,KAAA,CAAAqD,aAAA,CAAClD,WAAW,EAAAmD,QAAA;QACVjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBN,gBAAgB,CACrB,CAAC;IAEN,KAAKlC,UAAU,CAACsB,KAAK;MACnB,oBACEjC,KAAA,CAAAqD,aAAA,CAACnD,WAAW,EAAAoD,QAAA;QACVjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBL,gBAAgB,CACrB,CAAC;IAEN,KAAKnC,UAAU,CAACuB,GAAG;MACjB,oBACElC,KAAA,CAAAqD,aAAA,CAAC3C,SAAS,EAAA4C,QAAA;QACRjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBJ,cAAc,CACnB,CAAC;IAEN,KAAKpC,UAAU,CAACwB,WAAW;MACzB,oBACEnC,KAAA,CAAAqD,aAAA;QAAKf,SAAS,EAAEa;MAAc,gBAC5BnD,KAAA,CAAAqD,aAAA;QAAKf,SAAS,EAAEzB,MAAM,CAAC0C;MAAqB,gBAC1CvD,KAAA,CAAAqD,aAAA,CAACvD,YAAY;QAACwC,SAAS,EAAEzB,MAAM,CAAC2C;MAAgB,CAAE,CAAC,2BAC5B,EAACrC,QACrB,CACF,CAAC;IAEV;MACEX,iBAAiB,CAAC0C,UAAU,CAAC;EACjC;AACF","ignoreList":[]}
|
|
1
|
+
{"version":3,"file":"DocumentViewer.js","names":["Document","DocumentIcon","classnames","React","useMemo","EmailViewer","ImageViewer","TiffViewerMedia","MarkdownViewerMedia","PdfViewer","assertUnreachable","SpreadsheetViewer","VideoViewer","XmlViewer","ViewerType","TiffDocumentViewer","styles","IMAGE_MIME_TYPES","Set","MARKDOWN_MIME_TYPES","XML_MIME_TYPES","isTiffFile","mimeType","fileName","lowered","toLowerCase","endsWith","getViewerType","Pdf","Tiff","has","Image","startsWith","Video","Markdown","Spreadsheet","Email","Xml","Unsupported","DocumentViewer","media","className","mimeTypeOverride","pdfViewerProps","imageViewerProps","videoViewerProps","tiffRendererProps","markdownRendererProps","spreadsheetViewerProps","emailViewerProps","xmlViewerProps","enableTiffToPdf","getMediaReference","viewerType","rootClassName","container","createElement","_extends","unsupportedContainer","unsupportedIcon"],"sources":["DocumentViewer.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\n/* cspell:words openxmlformats officedocument wordprocessingml spreadsheetml */\n\nimport { Document as DocumentIcon } from \"@blueprintjs/icons\";\nimport classnames from \"classnames\";\nimport React, { useMemo } from \"react\";\n\nimport { EmailViewer } from \"../email-viewer/EmailViewer.js\";\nimport { ImageViewer } from \"../images/image-viewer/ImageViewer.js\";\nimport { TiffViewerMedia } from \"../images/tiff-renderer/TiffViewerMedia.js\";\nimport { MarkdownViewerMedia } from \"../markdown-renderer/MarkdownViewerMedia.js\";\nimport { PdfViewer } from \"../pdf-viewer/PdfRenderer.js\";\nimport { assertUnreachable } from \"../shared/assertUnreachable.js\";\nimport { SpreadsheetViewer } from \"../spreadsheet-viewer/SpreadsheetViewer.js\";\nimport { VideoViewer } from \"../video-viewer/VideoViewer.js\";\nimport { XmlViewer } from \"../xml-viewer/XmlViewer.js\";\nimport type { DocumentViewerProps } from \"./DocumentViewerApi.js\";\nimport { ViewerType } from \"./DocumentViewerApi.js\";\nimport { TiffDocumentViewer } from \"./TiffDocumentViewer.js\";\n\nimport styles from \"./DocumentViewer.module.css\";\n\nconst IMAGE_MIME_TYPES = new Set([\n \"image/png\",\n \"image/jpeg\",\n \"image/gif\",\n \"image/svg+xml\",\n \"image/webp\",\n \"image/bmp\",\n]);\n\nconst MARKDOWN_MIME_TYPES = new Set([\"text/markdown\", \"text/x-markdown\"]);\n\nconst XML_MIME_TYPES = new Set([\"application/xml\", \"text/xml\"]);\n\nfunction isTiffFile(mimeType: string, fileName: string | undefined): boolean {\n if (mimeType === \"image/tiff\") {\n return true;\n }\n const lowered = fileName?.toLowerCase();\n return (\n lowered?.endsWith(\".tif\") === true || lowered?.endsWith(\".tiff\") === true\n );\n}\n\nfunction getViewerType(\n mimeType: string,\n fileName: string | undefined,\n): ViewerType {\n if (mimeType === \"application/pdf\") {\n return ViewerType.Pdf;\n }\n if (isTiffFile(mimeType, fileName)) {\n return ViewerType.Tiff;\n }\n if (IMAGE_MIME_TYPES.has(mimeType)) {\n return ViewerType.Image;\n }\n if (mimeType.startsWith(\"video/\")) {\n return ViewerType.Video;\n }\n if (MARKDOWN_MIME_TYPES.has(mimeType)) {\n return ViewerType.Markdown;\n }\n if (\n mimeType ===\n \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\"\n ) {\n return ViewerType.Spreadsheet;\n }\n if (mimeType === \"message/rfc822\") {\n return ViewerType.Email;\n }\n if (XML_MIME_TYPES.has(mimeType)) {\n return ViewerType.Xml;\n }\n return ViewerType.Unsupported;\n}\n\nexport function DocumentViewer({\n media,\n className,\n mimeTypeOverride,\n pdfViewerProps,\n imageViewerProps,\n videoViewerProps,\n tiffRendererProps,\n markdownRendererProps,\n spreadsheetViewerProps,\n emailViewerProps,\n xmlViewerProps,\n fileName,\n enableTiffToPdf = false,\n}: DocumentViewerProps): React.ReactElement {\n const mimeType = mimeTypeOverride ?? media.getMediaReference().mimeType;\n const viewerType = useMemo(\n () => getViewerType(mimeType, fileName),\n [mimeType, fileName],\n );\n const rootClassName = classnames(styles.container, className);\n\n switch (viewerType) {\n case ViewerType.Pdf:\n return (\n <PdfViewer\n media={media}\n className={rootClassName}\n {...pdfViewerProps}\n />\n );\n case ViewerType.Tiff:\n if (enableTiffToPdf) {\n return (\n <TiffDocumentViewer\n media={media}\n className={rootClassName}\n enableTiffToPdf={enableTiffToPdf}\n tiffRendererProps={tiffRendererProps}\n pdfViewerProps={pdfViewerProps}\n />\n );\n }\n return (\n <TiffViewerMedia\n media={media}\n className={rootClassName}\n {...tiffRendererProps}\n />\n );\n case ViewerType.Image:\n return (\n <ImageViewer\n media={media}\n className={rootClassName}\n {...imageViewerProps}\n />\n );\n case ViewerType.Video:\n return (\n <VideoViewer\n media={media}\n className={rootClassName}\n {...videoViewerProps}\n />\n );\n case ViewerType.Markdown:\n return (\n <MarkdownViewerMedia\n media={media}\n className={rootClassName}\n {...markdownRendererProps}\n />\n );\n case ViewerType.Spreadsheet:\n return (\n <SpreadsheetViewer\n media={media}\n className={rootClassName}\n {...spreadsheetViewerProps}\n />\n );\n case ViewerType.Email:\n return (\n <EmailViewer\n media={media}\n className={rootClassName}\n {...emailViewerProps}\n />\n );\n case ViewerType.Xml:\n return (\n <XmlViewer\n media={media}\n className={rootClassName}\n {...xmlViewerProps}\n />\n );\n case ViewerType.Unsupported:\n return (\n <div className={rootClassName}>\n <div className={styles.unsupportedContainer}>\n <DocumentIcon className={styles.unsupportedIcon} />\n Unsupported file type: {mimeType}\n </div>\n </div>\n );\n default:\n assertUnreachable(viewerType);\n }\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;;AAEA,SAASA,QAAQ,IAAIC,YAAY,QAAQ,oBAAoB;AAC7D,OAAOC,UAAU,MAAM,YAAY;AACnC,OAAOC,KAAK,IAAIC,OAAO,QAAQ,OAAO;AAEtC,SAASC,WAAW,QAAQ,gCAAgC;AAC5D,SAASC,WAAW,QAAQ,uCAAuC;AACnE,SAASC,eAAe,QAAQ,4CAA4C;AAC5E,SAASC,mBAAmB,QAAQ,6CAA6C;AACjF,SAASC,SAAS,QAAQ,8BAA8B;AACxD,SAASC,iBAAiB,QAAQ,gCAAgC;AAClE,SAASC,iBAAiB,QAAQ,4CAA4C;AAC9E,SAASC,WAAW,QAAQ,gCAAgC;AAC5D,SAASC,SAAS,QAAQ,4BAA4B;AAEtD,SAASC,UAAU,QAAQ,wBAAwB;AACnD,SAASC,kBAAkB,QAAQ,yBAAyB;AAE5D,OAAOC,MAAM,MAAM,6BAA6B;AAEhD,MAAMC,gBAAgB,GAAG,IAAIC,GAAG,CAAC,CAC/B,WAAW,EACX,YAAY,EACZ,WAAW,EACX,eAAe,EACf,YAAY,EACZ,WAAW,CACZ,CAAC;AAEF,MAAMC,mBAAmB,GAAG,IAAID,GAAG,CAAC,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;AAEzE,MAAME,cAAc,GAAG,IAAIF,GAAG,CAAC,CAAC,iBAAiB,EAAE,UAAU,CAAC,CAAC;AAE/D,SAASG,UAAUA,CAACC,QAAgB,EAAEC,QAA4B,EAAW;EAC3E,IAAID,QAAQ,KAAK,YAAY,EAAE;IAC7B,OAAO,IAAI;EACb;EACA,MAAME,OAAO,GAAGD,QAAQ,EAAEE,WAAW,CAAC,CAAC;EACvC,OACED,OAAO,EAAEE,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI,IAAIF,OAAO,EAAEE,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI;AAE7E;AAEA,SAASC,aAAaA,CACpBL,QAAgB,EAChBC,QAA4B,EAChB;EACZ,IAAID,QAAQ,KAAK,iBAAiB,EAAE;IAClC,OAAOR,UAAU,CAACc,GAAG;EACvB;EACA,IAAIP,UAAU,CAACC,QAAQ,EAAEC,QAAQ,CAAC,EAAE;IAClC,OAAOT,UAAU,CAACe,IAAI;EACxB;EACA,IAAIZ,gBAAgB,CAACa,GAAG,CAACR,QAAQ,CAAC,EAAE;IAClC,OAAOR,UAAU,CAACiB,KAAK;EACzB;EACA,IAAIT,QAAQ,CAACU,UAAU,CAAC,QAAQ,CAAC,EAAE;IACjC,OAAOlB,UAAU,CAACmB,KAAK;EACzB;EACA,IAAId,mBAAmB,CAACW,GAAG,CAACR,QAAQ,CAAC,EAAE;IACrC,OAAOR,UAAU,CAACoB,QAAQ;EAC5B;EACA,IACEZ,QAAQ,KACR,mEAAmE,EACnE;IACA,OAAOR,UAAU,CAACqB,WAAW;EAC/B;EACA,IAAIb,QAAQ,KAAK,gBAAgB,EAAE;IACjC,OAAOR,UAAU,CAACsB,KAAK;EACzB;EACA,IAAIhB,cAAc,CAACU,GAAG,CAACR,QAAQ,CAAC,EAAE;IAChC,OAAOR,UAAU,CAACuB,GAAG;EACvB;EACA,OAAOvB,UAAU,CAACwB,WAAW;AAC/B;AAEA,OAAO,SAASC,cAAcA,CAAC;EAC7BC,KAAK;EACLC,SAAS;EACTC,gBAAgB;EAChBC,cAAc;EACdC,gBAAgB;EAChBC,gBAAgB;EAChBC,iBAAiB;EACjBC,qBAAqB;EACrBC,sBAAsB;EACtBC,gBAAgB;EAChBC,cAAc;EACd3B,QAAQ;EACR4B,eAAe,GAAG;AACC,CAAC,EAAsB;EAC1C,MAAM7B,QAAQ,GAAGoB,gBAAgB,IAAIF,KAAK,CAACY,iBAAiB,CAAC,CAAC,CAAC9B,QAAQ;EACvE,MAAM+B,UAAU,GAAGjD,OAAO,CACxB,MAAMuB,aAAa,CAACL,QAAQ,EAAEC,QAAQ,CAAC,EACvC,CAACD,QAAQ,EAAEC,QAAQ,CACrB,CAAC;EACD,MAAM+B,aAAa,GAAGpD,UAAU,CAACc,MAAM,CAACuC,SAAS,EAAEd,SAAS,CAAC;EAE7D,QAAQY,UAAU;IAChB,KAAKvC,UAAU,CAACc,GAAG;MACjB,oBACEzB,KAAA,CAAAqD,aAAA,CAAC/C,SAAS,EAAAgD,QAAA;QACRjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBX,cAAc,CACnB,CAAC;IAEN,KAAK7B,UAAU,CAACe,IAAI;MAClB,IAAIsB,eAAe,EAAE;QACnB,oBACEhD,KAAA,CAAAqD,aAAA,CAACzC,kBAAkB;UACjByB,KAAK,EAAEA,KAAM;UACbC,SAAS,EAAEa,aAAc;UACzBH,eAAe,EAAEA,eAAgB;UACjCL,iBAAiB,EAAEA,iBAAkB;UACrCH,cAAc,EAAEA;QAAe,CAChC,CAAC;MAEN;MACA,oBACExC,KAAA,CAAAqD,aAAA,CAACjD,eAAe,EAAAkD,QAAA;QACdjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBR,iBAAiB,CACtB,CAAC;IAEN,KAAKhC,UAAU,CAACiB,KAAK;MACnB,oBACE5B,KAAA,CAAAqD,aAAA,CAAClD,WAAW,EAAAmD,QAAA;QACVjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBV,gBAAgB,CACrB,CAAC;IAEN,KAAK9B,UAAU,CAACmB,KAAK;MACnB,oBACE9B,KAAA,CAAAqD,aAAA,CAAC5C,WAAW,EAAA6C,QAAA;QACVjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBT,gBAAgB,CACrB,CAAC;IAEN,KAAK/B,UAAU,CAACoB,QAAQ;MACtB,oBACE/B,KAAA,CAAAqD,aAAA,CAAChD,mBAAmB,EAAAiD,QAAA;QAClBjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBP,qBAAqB,CAC1B,CAAC;IAEN,KAAKjC,UAAU,CAACqB,WAAW;MACzB,oBACEhC,KAAA,CAAAqD,aAAA,CAAC7C,iBAAiB,EAAA8C,QAAA;QAChBjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBN,sBAAsB,CAC3B,CAAC;IAEN,KAAKlC,UAAU,CAACsB,KAAK;MACnB,oBACEjC,KAAA,CAAAqD,aAAA,CAACnD,WAAW,EAAAoD,QAAA;QACVjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBL,gBAAgB,CACrB,CAAC;IAEN,KAAKnC,UAAU,CAACuB,GAAG;MACjB,oBACElC,KAAA,CAAAqD,aAAA,CAAC3C,SAAS,EAAA4C,QAAA;QACRjB,KAAK,EAAEA,KAAM;QACbC,SAAS,EAAEa;MAAc,GACrBJ,cAAc,CACnB,CAAC;IAEN,KAAKpC,UAAU,CAACwB,WAAW;MACzB,oBACEnC,KAAA,CAAAqD,aAAA;QAAKf,SAAS,EAAEa;MAAc,gBAC5BnD,KAAA,CAAAqD,aAAA;QAAKf,SAAS,EAAEzB,MAAM,CAAC0C;MAAqB,gBAC1CvD,KAAA,CAAAqD,aAAA,CAACvD,YAAY;QAACwC,SAAS,EAAEzB,MAAM,CAAC2C;MAAgB,CAAE,CAAC,2BAC5B,EAACrC,QACrB,CACF,CAAC;IAEV;MACEZ,iBAAiB,CAAC2C,UAAU,CAAC;EACjC;AACF","ignoreList":[]}
|
|
@@ -20,7 +20,7 @@ export let ViewerType = /*#__PURE__*/function (ViewerType) {
|
|
|
20
20
|
ViewerType["Image"] = "image";
|
|
21
21
|
ViewerType["Video"] = "video";
|
|
22
22
|
ViewerType["Markdown"] = "markdown";
|
|
23
|
-
ViewerType["
|
|
23
|
+
ViewerType["Spreadsheet"] = "spreadsheet";
|
|
24
24
|
ViewerType["Email"] = "email";
|
|
25
25
|
ViewerType["Xml"] = "xml";
|
|
26
26
|
ViewerType["Unsupported"] = "unsupported";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DocumentViewerApi.js","names":["ViewerType"],"sources":["DocumentViewerApi.ts"],"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 type { Media } from \"@osdk/api\";\n\nimport type { BaseEmailViewerProps } from \"../email-viewer/EmailViewerApi.js\";\nimport type {
|
|
1
|
+
{"version":3,"file":"DocumentViewerApi.js","names":["ViewerType"],"sources":["DocumentViewerApi.ts"],"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 type { Media } from \"@osdk/api\";\n\nimport type { BaseEmailViewerProps } from \"../email-viewer/EmailViewerApi.js\";\nimport type { BaseImageViewerProps } from \"../images/image-viewer/ImageViewerApi.js\";\nimport type { TiffRendererProps } from \"../images/tiff-renderer/types.js\";\nimport type { MarkdownRendererProps } from \"../markdown-renderer/MarkdownRenderer.js\";\nimport type { PdfViewerProps } from \"../pdf-viewer/types.js\";\nimport type { BaseSpreadsheetViewerProps } from \"../spreadsheet-viewer/SpreadsheetViewerApi.js\";\nimport type { BaseVideoViewerProps } from \"../video-viewer/VideoViewerApi.js\";\nimport type { BaseXmlViewerProps } from \"../xml-viewer/XmlViewerApi.js\";\n\nexport enum ViewerType {\n Pdf = \"pdf\",\n Tiff = \"tiff\",\n Image = \"image\",\n Video = \"video\",\n Markdown = \"markdown\",\n Spreadsheet = \"spreadsheet\",\n Email = \"email\",\n Xml = \"xml\",\n Unsupported = \"unsupported\",\n}\n\nexport interface DocumentViewerProps {\n /** The Media object to render */\n media: Media;\n /** Additional CSS class name for the root element\n * @default undefined */\n className?: string;\n /** Override the auto-detected MIME type\n * @default undefined */\n mimeTypeOverride?: string;\n /** Props forwarded to BasePdfViewer when rendering PDF\n * @default undefined */\n pdfViewerProps?: Partial<Omit<PdfViewerProps, \"src\" | \"className\">>;\n /** Props forwarded to BaseImageViewer when rendering images\n * @default undefined */\n imageViewerProps?: Partial<Omit<BaseImageViewerProps, \"src\" | \"className\">>;\n /** Props forwarded to BaseVideoViewer when rendering video\n * @default undefined */\n videoViewerProps?: Partial<Omit<BaseVideoViewerProps, \"src\" | \"className\">>;\n /** Props forwarded to TiffRenderer when rendering TIFF\n * @default undefined */\n tiffRendererProps?: Partial<Omit<TiffRendererProps, \"content\" | \"className\">>;\n /** Props forwarded to MarkdownRenderer when rendering markdown\n * @default undefined */\n markdownRendererProps?: Partial<\n Omit<MarkdownRendererProps, \"content\" | \"className\">\n >;\n /** Props forwarded to BaseSpreadsheetViewer when rendering a spreadsheet\n * @default undefined */\n spreadsheetViewerProps?: Partial<\n Omit<BaseSpreadsheetViewerProps, \"spreadsheet\" | \"className\">\n >;\n /** Props forwarded to BaseEmailViewer when rendering EML\n * @default undefined */\n emailViewerProps?: Partial<Omit<BaseEmailViewerProps, \"email\" | \"className\">>;\n /** Props forwarded to BaseXmlViewer when rendering XML\n * @default undefined */\n xmlViewerProps?: Partial<Omit<BaseXmlViewerProps, \"content\" | \"className\">>;\n /** File name hint for MIME type detection (e.g. \"scan.tif\"). Used to detect\n * TIFF files when the MIME type is ambiguous (e.g. application/octet-stream).\n * @default undefined */\n fileName?: string;\n /** When true, multi-page TIFF files are converted to PDF via MIO transform API\n * @default false */\n enableTiffToPdf?: boolean;\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA,WAAYA,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","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 { 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 /**\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 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 * 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 column configuration dialog for column visibility and ordering is available to the user.\n *\n * @default true\n */\n enableColumnConfig?: 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 * 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 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 * Whether the table is sortable by the user.\n *\n * @default true\n */\n enableOrdering?: 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 * 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 /**\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 * 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 * 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 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 * 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 * The height of each row in pixels.\n *\n * @default 40\n */\n rowHeight?: number;\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 * 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":[]}
|
|
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 /**\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 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 * 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 column configuration dialog for column visibility and ordering is available to the user.\n *\n * @default true\n */\n enableColumnConfig?: 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 * 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 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 * Whether the table is sortable by the user.\n *\n * @default true\n */\n enableOrdering?: 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 * 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 /**\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 * 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 * 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 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 * 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 * The height of each row in pixels.\n *\n * @default 40\n */\n rowHeight?: number;\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 * 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, Spreadsheet, 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":[]}
|
|
@@ -14,10 +14,10 @@
|
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
|
-
//
|
|
18
|
-
export {
|
|
19
|
-
//
|
|
20
|
-
import {
|
|
17
|
+
// BaseSpreadsheetViewer
|
|
18
|
+
export { BaseSpreadsheetViewer } from "../../spreadsheet-viewer/BaseSpreadsheetViewer.js";
|
|
19
|
+
// SpreadsheetViewer (Media wrapper)
|
|
20
|
+
import { SpreadsheetViewer as _SpreadsheetViewer } from "../../spreadsheet-viewer/SpreadsheetViewer.js";
|
|
21
21
|
import { withOsdkMetrics } from "../../util/withOsdkMetrics.js";
|
|
22
|
-
export const
|
|
23
|
-
//# sourceMappingURL=
|
|
22
|
+
export const SpreadsheetViewer = withOsdkMetrics(_SpreadsheetViewer, "SpreadsheetViewer");
|
|
23
|
+
//# sourceMappingURL=spreadsheet-viewer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"spreadsheet-viewer.js","names":["BaseSpreadsheetViewer","SpreadsheetViewer","_SpreadsheetViewer","withOsdkMetrics"],"sources":["spreadsheet-viewer.ts"],"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\n// BaseSpreadsheetViewer\nexport { BaseSpreadsheetViewer } from \"../../spreadsheet-viewer/BaseSpreadsheetViewer.js\";\nexport type {\n BaseSpreadsheetViewerProps,\n ParsedSpreadsheet,\n SheetData,\n SpreadsheetViewerMediaProps,\n} from \"../../spreadsheet-viewer/SpreadsheetViewerApi.js\";\n\n// SpreadsheetViewer (Media wrapper)\nimport { SpreadsheetViewer as _SpreadsheetViewer } from \"../../spreadsheet-viewer/SpreadsheetViewer.js\";\nimport { withOsdkMetrics } from \"../../util/withOsdkMetrics.js\";\nexport const SpreadsheetViewer: typeof _SpreadsheetViewer = withOsdkMetrics(\n _SpreadsheetViewer,\n \"SpreadsheetViewer\",\n);\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA,SAASA,qBAAqB,QAAQ,mDAAmD;AAQzF;AACA,SAASC,iBAAiB,IAAIC,kBAAkB,QAAQ,+CAA+C;AACvG,SAASC,eAAe,QAAQ,+BAA+B;AAC/D,OAAO,MAAMF,iBAA4C,GAAGE,eAAe,CACzED,kBAAkB,EAClB,mBACF,CAAC","ignoreList":[]}
|
|
@@ -18,12 +18,12 @@ export * from "./experimental/action-form.js";
|
|
|
18
18
|
export * from "./experimental/cbac-picker.js";
|
|
19
19
|
export * from "./experimental/document-viewer.js";
|
|
20
20
|
export * from "./experimental/email-viewer.js";
|
|
21
|
-
export * from "./experimental/excel-viewer.js";
|
|
22
21
|
export * from "./experimental/filter-list.js";
|
|
23
22
|
export * from "./experimental/image-viewer.js";
|
|
24
23
|
export * from "./experimental/markdown-renderer.js";
|
|
25
24
|
export * from "./experimental/object-table.js";
|
|
26
25
|
export * from "./experimental/pdf-viewer.js";
|
|
26
|
+
export * from "./experimental/spreadsheet-viewer.js";
|
|
27
27
|
export * from "./experimental/theme.js";
|
|
28
28
|
export * from "./experimental/tiff-renderer.js";
|
|
29
29
|
export * from "./experimental/video-viewer.js";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"experimental.js","names":[],"sources":["experimental.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\nexport * from \"./experimental/action-form.js\";\nexport * from \"./experimental/cbac-picker.js\";\nexport * from \"./experimental/document-viewer.js\";\nexport * from \"./experimental/email-viewer.js\";\nexport * from \"./experimental/
|
|
1
|
+
{"version":3,"file":"experimental.js","names":[],"sources":["experimental.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\nexport * from \"./experimental/action-form.js\";\nexport * from \"./experimental/cbac-picker.js\";\nexport * from \"./experimental/document-viewer.js\";\nexport * from \"./experimental/email-viewer.js\";\nexport * from \"./experimental/filter-list.js\";\nexport * from \"./experimental/image-viewer.js\";\nexport * from \"./experimental/markdown-renderer.js\";\nexport * from \"./experimental/object-table.js\";\nexport * from \"./experimental/pdf-viewer.js\";\nexport * from \"./experimental/spreadsheet-viewer.js\";\nexport * from \"./experimental/theme.js\";\nexport * from \"./experimental/tiff-renderer.js\";\nexport * from \"./experimental/video-viewer.js\";\nexport * from \"./experimental/xml-viewer.js\";\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,cAAc,+BAA+B;AAC7C,cAAc,+BAA+B;AAC7C,cAAc,mCAAmC;AACjD,cAAc,gCAAgC;AAC9C,cAAc,+BAA+B;AAC7C,cAAc,gCAAgC;AAC9C,cAAc,qCAAqC;AACnD,cAAc,gCAAgC;AAC9C,cAAc,8BAA8B;AAC5C,cAAc,sCAAsC;AACpD,cAAc,yBAAyB;AACvC,cAAc,iCAAiC;AAC/C,cAAc,gCAAgC;AAC9C,cAAc,8BAA8B","ignoreList":[]}
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
import classnames from "classnames";
|
|
18
18
|
import React, { useCallback, useMemo, useState } from "react";
|
|
19
|
-
import styles from "./
|
|
19
|
+
import styles from "./BaseSpreadsheetViewer.module.css.js";
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
22
|
* Converts a 0-based column index to a spreadsheet column letter (0=A, 1=B, ..., 25=Z, 26=AA).
|
|
@@ -63,7 +63,7 @@ const SheetTable = /*#__PURE__*/React.memo(({
|
|
|
63
63
|
}, row[cellIndex] ?? "")))))));
|
|
64
64
|
});
|
|
65
65
|
SheetTable.displayName = "SheetTable";
|
|
66
|
-
export function
|
|
66
|
+
export function BaseSpreadsheetViewer({
|
|
67
67
|
spreadsheet,
|
|
68
68
|
className
|
|
69
69
|
}) {
|
|
@@ -91,4 +91,4 @@ export function BaseExcelViewer({
|
|
|
91
91
|
type: "button"
|
|
92
92
|
}, sheet.name))));
|
|
93
93
|
}
|
|
94
|
-
//# sourceMappingURL=
|
|
94
|
+
//# sourceMappingURL=BaseSpreadsheetViewer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BaseSpreadsheetViewer.js","names":["classnames","React","useCallback","useMemo","useState","styles","columnIndexToLetter","index","letter","num","remainder","String","fromCharCode","Math","floor","SheetTable","memo","sheet","maxCols","rows","reduce","max","row","length","createElement","className","emptySheet","tableContainer","table","cornerCell","Array","from","_","i","key","columnHeader","map","rowIndex","rowHeader","cellIndex","cell","displayName","BaseSpreadsheetViewer","spreadsheet","activeSheetIndex","setActiveSheetIndex","rootClassName","container","safeIndex","min","sheets","activeSheet","handleTabClick","tabBar","name","tab","tabActive","onClick","type"],"sources":["BaseSpreadsheetViewer.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 classnames from \"classnames\";\nimport React, { useCallback, useMemo, useState } from \"react\";\n\nimport type {\n BaseSpreadsheetViewerProps,\n SheetData,\n} from \"./SpreadsheetViewerApi.js\";\n\nimport styles from \"./BaseSpreadsheetViewer.module.css\";\n\n/**\n * Converts a 0-based column index to a spreadsheet column letter (0=A, 1=B, ..., 25=Z, 26=AA).\n */\nfunction columnIndexToLetter(index: number): string {\n let letter = \"\";\n let num = index;\n do {\n const remainder = num % 26;\n letter = String.fromCharCode(65 + remainder) + letter;\n num = Math.floor(num / 26) - 1;\n } while (num >= 0);\n return letter;\n}\n\nconst SheetTable: React.FunctionComponent<{ sheet: SheetData }> = React.memo(\n ({ sheet }) => {\n const maxCols = useMemo(\n () => sheet.rows.reduce((max, row) => Math.max(max, row.length), 0),\n [sheet.rows],\n );\n\n if (sheet.rows.length === 0) {\n return <div className={styles.emptySheet}>Empty sheet</div>;\n }\n\n return (\n <div className={styles.tableContainer}>\n <table className={styles.table}>\n <thead>\n <tr>\n <th className={styles.cornerCell} />\n {Array.from({ length: maxCols }, (_, i) => (\n <th key={i} className={styles.columnHeader}>\n {columnIndexToLetter(i)}\n </th>\n ))}\n </tr>\n </thead>\n <tbody>\n {sheet.rows.map((row, rowIndex) => (\n <tr key={rowIndex}>\n <td className={styles.rowHeader}>{rowIndex + 1}</td>\n {Array.from({ length: maxCols }, (_, cellIndex) => (\n <td key={cellIndex} className={styles.cell}>\n {row[cellIndex] ?? \"\"}\n </td>\n ))}\n </tr>\n ))}\n </tbody>\n </table>\n </div>\n );\n },\n);\nSheetTable.displayName = \"SheetTable\";\n\nexport function BaseSpreadsheetViewer({\n spreadsheet,\n className,\n}: BaseSpreadsheetViewerProps): React.ReactElement {\n const [activeSheetIndex, setActiveSheetIndex] = useState(0);\n const rootClassName = classnames(styles.container, className);\n\n const safeIndex = Math.min(\n activeSheetIndex,\n Math.max(0, spreadsheet.sheets.length - 1),\n );\n const activeSheet = useMemo(\n () => spreadsheet.sheets[safeIndex],\n [spreadsheet.sheets, safeIndex],\n );\n\n const handleTabClick = useCallback((index: number) => {\n setActiveSheetIndex(index);\n }, []);\n\n return (\n <div className={rootClassName}>\n {activeSheet != null ? (\n <SheetTable sheet={activeSheet} />\n ) : (\n <div className={styles.emptySheet}>No sheets</div>\n )}\n {spreadsheet.sheets.length > 1 && (\n <div className={styles.tabBar}>\n {spreadsheet.sheets.map((sheet, index) => (\n <button\n key={sheet.name}\n className={classnames(styles.tab, {\n [styles.tabActive]: index === safeIndex,\n })}\n onClick={() => handleTabClick(index)}\n type=\"button\"\n >\n {sheet.name}\n </button>\n ))}\n </div>\n )}\n </div>\n );\n}\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,OAAOA,UAAU,MAAM,YAAY;AACnC,OAAOC,KAAK,IAAIC,WAAW,EAAEC,OAAO,EAAEC,QAAQ,QAAQ,OAAO;AAO7D,OAAOC,MAAM,MAAM,oCAAoC;;AAEvD;AACA;AACA;AACA,SAASC,mBAAmBA,CAACC,KAAa,EAAU;EAClD,IAAIC,MAAM,GAAG,EAAE;EACf,IAAIC,GAAG,GAAGF,KAAK;EACf,GAAG;IACD,MAAMG,SAAS,GAAGD,GAAG,GAAG,EAAE;IAC1BD,MAAM,GAAGG,MAAM,CAACC,YAAY,CAAC,EAAE,GAAGF,SAAS,CAAC,GAAGF,MAAM;IACrDC,GAAG,GAAGI,IAAI,CAACC,KAAK,CAACL,GAAG,GAAG,EAAE,CAAC,GAAG,CAAC;EAChC,CAAC,QAAQA,GAAG,IAAI,CAAC;EACjB,OAAOD,MAAM;AACf;AAEA,MAAMO,UAAyD,gBAAGd,KAAK,CAACe,IAAI,CAC1E,CAAC;EAAEC;AAAM,CAAC,KAAK;EACb,MAAMC,OAAO,GAAGf,OAAO,CACrB,MAAMc,KAAK,CAACE,IAAI,CAACC,MAAM,CAAC,CAACC,GAAG,EAAEC,GAAG,KAAKT,IAAI,CAACQ,GAAG,CAACA,GAAG,EAAEC,GAAG,CAACC,MAAM,CAAC,EAAE,CAAC,CAAC,EACnE,CAACN,KAAK,CAACE,IAAI,CACb,CAAC;EAED,IAAIF,KAAK,CAACE,IAAI,CAACI,MAAM,KAAK,CAAC,EAAE;IAC3B,oBAAOtB,KAAA,CAAAuB,aAAA;MAAKC,SAAS,EAAEpB,MAAM,CAACqB;IAAW,GAAC,aAAgB,CAAC;EAC7D;EAEA,oBACEzB,KAAA,CAAAuB,aAAA;IAAKC,SAAS,EAAEpB,MAAM,CAACsB;EAAe,gBACpC1B,KAAA,CAAAuB,aAAA;IAAOC,SAAS,EAAEpB,MAAM,CAACuB;EAAM,gBAC7B3B,KAAA,CAAAuB,aAAA,6BACEvB,KAAA,CAAAuB,aAAA,0BACEvB,KAAA,CAAAuB,aAAA;IAAIC,SAAS,EAAEpB,MAAM,CAACwB;EAAW,CAAE,CAAC,EACnCC,KAAK,CAACC,IAAI,CAAC;IAAER,MAAM,EAAEL;EAAQ,CAAC,EAAE,CAACc,CAAC,EAAEC,CAAC,kBACpChC,KAAA,CAAAuB,aAAA;IAAIU,GAAG,EAAED,CAAE;IAACR,SAAS,EAAEpB,MAAM,CAAC8B;EAAa,GACxC7B,mBAAmB,CAAC2B,CAAC,CACpB,CACL,CACC,CACC,CAAC,eACRhC,KAAA,CAAAuB,aAAA,gBACGP,KAAK,CAACE,IAAI,CAACiB,GAAG,CAAC,CAACd,GAAG,EAAEe,QAAQ,kBAC5BpC,KAAA,CAAAuB,aAAA;IAAIU,GAAG,EAAEG;EAAS,gBAChBpC,KAAA,CAAAuB,aAAA;IAAIC,SAAS,EAAEpB,MAAM,CAACiC;EAAU,GAAED,QAAQ,GAAG,CAAM,CAAC,EACnDP,KAAK,CAACC,IAAI,CAAC;IAAER,MAAM,EAAEL;EAAQ,CAAC,EAAE,CAACc,CAAC,EAAEO,SAAS,kBAC5CtC,KAAA,CAAAuB,aAAA;IAAIU,GAAG,EAAEK,SAAU;IAACd,SAAS,EAAEpB,MAAM,CAACmC;EAAK,GACxClB,GAAG,CAACiB,SAAS,CAAC,IAAI,EACjB,CACL,CACC,CACL,CACI,CACF,CACJ,CAAC;AAEV,CACF,CAAC;AACDxB,UAAU,CAAC0B,WAAW,GAAG,YAAY;AAErC,OAAO,SAASC,qBAAqBA,CAAC;EACpCC,WAAW;EACXlB;AAC0B,CAAC,EAAsB;EACjD,MAAM,CAACmB,gBAAgB,EAAEC,mBAAmB,CAAC,GAAGzC,QAAQ,CAAC,CAAC,CAAC;EAC3D,MAAM0C,aAAa,GAAG9C,UAAU,CAACK,MAAM,CAAC0C,SAAS,EAAEtB,SAAS,CAAC;EAE7D,MAAMuB,SAAS,GAAGnC,IAAI,CAACoC,GAAG,CACxBL,gBAAgB,EAChB/B,IAAI,CAACQ,GAAG,CAAC,CAAC,EAAEsB,WAAW,CAACO,MAAM,CAAC3B,MAAM,GAAG,CAAC,CAC3C,CAAC;EACD,MAAM4B,WAAW,GAAGhD,OAAO,CACzB,MAAMwC,WAAW,CAACO,MAAM,CAACF,SAAS,CAAC,EACnC,CAACL,WAAW,CAACO,MAAM,EAAEF,SAAS,CAChC,CAAC;EAED,MAAMI,cAAc,GAAGlD,WAAW,CAAEK,KAAa,IAAK;IACpDsC,mBAAmB,CAACtC,KAAK,CAAC;EAC5B,CAAC,EAAE,EAAE,CAAC;EAEN,oBACEN,KAAA,CAAAuB,aAAA;IAAKC,SAAS,EAAEqB;EAAc,GAC3BK,WAAW,IAAI,IAAI,gBAClBlD,KAAA,CAAAuB,aAAA,CAACT,UAAU;IAACE,KAAK,EAAEkC;EAAY,CAAE,CAAC,gBAElClD,KAAA,CAAAuB,aAAA;IAAKC,SAAS,EAAEpB,MAAM,CAACqB;EAAW,GAAC,WAAc,CAClD,EACAiB,WAAW,CAACO,MAAM,CAAC3B,MAAM,GAAG,CAAC,iBAC5BtB,KAAA,CAAAuB,aAAA;IAAKC,SAAS,EAAEpB,MAAM,CAACgD;EAAO,GAC3BV,WAAW,CAACO,MAAM,CAACd,GAAG,CAAC,CAACnB,KAAK,EAAEV,KAAK,kBACnCN,KAAA,CAAAuB,aAAA;IACEU,GAAG,EAAEjB,KAAK,CAACqC,IAAK;IAChB7B,SAAS,EAAEzB,UAAU,CAACK,MAAM,CAACkD,GAAG,EAAE;MAChC,CAAClD,MAAM,CAACmD,SAAS,GAAGjD,KAAK,KAAKyC;IAChC,CAAC,CAAE;IACHS,OAAO,EAAEA,CAAA,KAAML,cAAc,CAAC7C,KAAK,CAAE;IACrCmD,IAAI,EAAC;EAAQ,GAEZzC,KAAK,CAACqC,IACD,CACT,CACE,CAEJ,CAAC;AAEV","ignoreList":[]}
|