@jmruthers/pace-core 0.5.94 → 0.5.97
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/dist/{DataTable-CHX2EFO3.js → DataTable-FB22ES46.js} +2 -2
- package/dist/{PublicLoadingSpinner-BWUD6bLU.d.ts → PublicLoadingSpinner-B84QWsvB.d.ts} +8 -1
- package/dist/{chunk-PRM6EYO3.js → chunk-QX5I62KP.js} +87 -12
- package/dist/chunk-QX5I62KP.js.map +1 -0
- package/dist/{chunk-O6GASC4Q.js → chunk-UBPRDNPY.js} +267 -182
- package/dist/chunk-UBPRDNPY.js.map +1 -0
- package/dist/components.d.ts +1 -1
- package/dist/components.js +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -2
- package/dist/utils.js +1 -1
- package/docs/api/classes/ColumnFactory.md +1 -1
- package/docs/api/classes/ErrorBoundary.md +1 -1
- package/docs/api/classes/InvalidScopeError.md +1 -1
- package/docs/api/classes/MissingUserContextError.md +1 -1
- package/docs/api/classes/OrganisationContextRequiredError.md +1 -1
- package/docs/api/classes/PermissionDeniedError.md +1 -1
- package/docs/api/classes/PublicErrorBoundary.md +1 -1
- package/docs/api/classes/RBACAuditManager.md +1 -1
- package/docs/api/classes/RBACCache.md +1 -1
- package/docs/api/classes/RBACEngine.md +1 -1
- package/docs/api/classes/RBACError.md +1 -1
- package/docs/api/classes/RBACNotInitializedError.md +1 -1
- package/docs/api/classes/SecureSupabaseClient.md +1 -1
- package/docs/api/classes/StorageUtils.md +1 -1
- package/docs/api/enums/FileCategory.md +1 -1
- package/docs/api/interfaces/AggregateConfig.md +1 -1
- package/docs/api/interfaces/ButtonProps.md +1 -1
- package/docs/api/interfaces/CardProps.md +1 -1
- package/docs/api/interfaces/ColorPalette.md +1 -1
- package/docs/api/interfaces/ColorShade.md +1 -1
- package/docs/api/interfaces/DataAccessRecord.md +1 -1
- package/docs/api/interfaces/DataRecord.md +1 -1
- package/docs/api/interfaces/DataTableAction.md +1 -1
- package/docs/api/interfaces/DataTableColumn.md +1 -1
- package/docs/api/interfaces/DataTableProps.md +1 -1
- package/docs/api/interfaces/DataTableToolbarButton.md +1 -1
- package/docs/api/interfaces/EmptyStateConfig.md +1 -1
- package/docs/api/interfaces/EnhancedNavigationMenuProps.md +1 -1
- package/docs/api/interfaces/EventLogoProps.md +1 -1
- package/docs/api/interfaces/FileDisplayProps.md +37 -11
- package/docs/api/interfaces/FileMetadata.md +1 -1
- package/docs/api/interfaces/FileReference.md +1 -1
- package/docs/api/interfaces/FileSizeLimits.md +1 -1
- package/docs/api/interfaces/FileUploadOptions.md +1 -1
- package/docs/api/interfaces/FileUploadProps.md +1 -1
- package/docs/api/interfaces/FooterProps.md +1 -1
- package/docs/api/interfaces/InactivityWarningModalProps.md +1 -1
- package/docs/api/interfaces/InputProps.md +1 -1
- package/docs/api/interfaces/LabelProps.md +1 -1
- package/docs/api/interfaces/LoginFormProps.md +1 -1
- package/docs/api/interfaces/NavigationAccessRecord.md +1 -1
- package/docs/api/interfaces/NavigationContextType.md +1 -1
- package/docs/api/interfaces/NavigationGuardProps.md +1 -1
- package/docs/api/interfaces/NavigationItem.md +1 -1
- package/docs/api/interfaces/NavigationMenuProps.md +1 -1
- package/docs/api/interfaces/NavigationProviderProps.md +1 -1
- package/docs/api/interfaces/Organisation.md +1 -1
- package/docs/api/interfaces/OrganisationContextType.md +1 -1
- package/docs/api/interfaces/OrganisationMembership.md +1 -1
- package/docs/api/interfaces/OrganisationProviderProps.md +1 -1
- package/docs/api/interfaces/OrganisationSecurityError.md +1 -1
- package/docs/api/interfaces/PaceAppLayoutProps.md +1 -1
- package/docs/api/interfaces/PaceLoginPageProps.md +1 -1
- package/docs/api/interfaces/PageAccessRecord.md +1 -1
- package/docs/api/interfaces/PagePermissionContextType.md +1 -1
- package/docs/api/interfaces/PagePermissionGuardProps.md +1 -1
- package/docs/api/interfaces/PagePermissionProviderProps.md +1 -1
- package/docs/api/interfaces/PaletteData.md +1 -1
- package/docs/api/interfaces/PermissionEnforcerProps.md +1 -1
- package/docs/api/interfaces/ProtectedRouteProps.md +1 -1
- package/docs/api/interfaces/PublicErrorBoundaryProps.md +1 -1
- package/docs/api/interfaces/PublicErrorBoundaryState.md +1 -1
- package/docs/api/interfaces/PublicLoadingSpinnerProps.md +1 -1
- package/docs/api/interfaces/PublicPageFooterProps.md +1 -1
- package/docs/api/interfaces/PublicPageHeaderProps.md +1 -1
- package/docs/api/interfaces/PublicPageLayoutProps.md +1 -1
- package/docs/api/interfaces/RBACConfig.md +1 -1
- package/docs/api/interfaces/RBACLogger.md +1 -1
- package/docs/api/interfaces/RoleBasedRouterContextType.md +1 -1
- package/docs/api/interfaces/RoleBasedRouterProps.md +1 -1
- package/docs/api/interfaces/RouteAccessRecord.md +1 -1
- package/docs/api/interfaces/RouteConfig.md +1 -1
- package/docs/api/interfaces/SecureDataContextType.md +1 -1
- package/docs/api/interfaces/SecureDataProviderProps.md +1 -1
- package/docs/api/interfaces/StorageConfig.md +1 -1
- package/docs/api/interfaces/StorageFileInfo.md +1 -1
- package/docs/api/interfaces/StorageFileMetadata.md +1 -1
- package/docs/api/interfaces/StorageListOptions.md +1 -1
- package/docs/api/interfaces/StorageListResult.md +1 -1
- package/docs/api/interfaces/StorageUploadOptions.md +1 -1
- package/docs/api/interfaces/StorageUploadResult.md +1 -1
- package/docs/api/interfaces/StorageUrlOptions.md +1 -1
- package/docs/api/interfaces/StyleImport.md +1 -1
- package/docs/api/interfaces/SwitchProps.md +1 -1
- package/docs/api/interfaces/ToastActionElement.md +1 -1
- package/docs/api/interfaces/ToastProps.md +1 -1
- package/docs/api/interfaces/UnifiedAuthContextType.md +1 -1
- package/docs/api/interfaces/UnifiedAuthProviderProps.md +1 -1
- package/docs/api/interfaces/UseEventLogoOptions.md +1 -1
- package/docs/api/interfaces/UseEventLogoReturn.md +1 -1
- package/docs/api/interfaces/UseInactivityTrackerOptions.md +1 -1
- package/docs/api/interfaces/UseInactivityTrackerReturn.md +1 -1
- package/docs/api/interfaces/UsePublicEventLogoOptions.md +1 -1
- package/docs/api/interfaces/UsePublicEventLogoReturn.md +1 -1
- package/docs/api/interfaces/UsePublicEventOptions.md +1 -1
- package/docs/api/interfaces/UsePublicEventReturn.md +1 -1
- package/docs/api/interfaces/UsePublicFileDisplayOptions.md +1 -1
- package/docs/api/interfaces/UsePublicFileDisplayReturn.md +1 -1
- package/docs/api/interfaces/UsePublicRouteParamsReturn.md +1 -1
- package/docs/api/interfaces/UseResolvedScopeOptions.md +1 -1
- package/docs/api/interfaces/UseResolvedScopeReturn.md +1 -1
- package/docs/api/interfaces/UserEventAccess.md +1 -1
- package/docs/api/interfaces/UserMenuProps.md +1 -1
- package/docs/api/interfaces/UserProfile.md +1 -1
- package/docs/api/modules.md +3 -3
- package/docs/implementation-guides/data-tables.md +156 -1
- package/package.json +1 -1
- package/src/components/DataTable/DataTable.tsx +1 -1
- package/src/components/DataTable/components/DataTableCore.tsx +62 -11
- package/src/components/DataTable/components/DataTableModals.tsx +76 -5
- package/src/components/DataTable/utils/exportUtils.ts +18 -2
- package/src/components/FileDisplay/FileDisplay.tsx +189 -147
- package/src/hooks/useFileUrl.ts +130 -0
- package/dist/chunk-O6GASC4Q.js.map +0 -1
- package/dist/chunk-PRM6EYO3.js.map +0 -1
- /package/dist/{DataTable-CHX2EFO3.js.map → DataTable-FB22ES46.js.map} +0 -0
package/docs/api/modules.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
[@jmruthers/pace-core - v0.5.
|
|
1
|
+
[@jmruthers/pace-core - v0.5.97](README.md) / Exports
|
|
2
2
|
|
|
3
|
-
# @jmruthers/pace-core - v0.5.
|
|
3
|
+
# @jmruthers/pace-core - v0.5.97
|
|
4
4
|
|
|
5
5
|
**`File`**
|
|
6
6
|
|
|
@@ -1676,7 +1676,7 @@ React element with file display
|
|
|
1676
1676
|
|
|
1677
1677
|
#### Defined in
|
|
1678
1678
|
|
|
1679
|
-
[packages/core/src/components/FileDisplay/FileDisplay.tsx:
|
|
1679
|
+
[packages/core/src/components/FileDisplay/FileDisplay.tsx:825](https://github.com/jmruthers/pace-core/blob/main/packages/core/src/components/FileDisplay/FileDisplay.tsx#L825)
|
|
1680
1680
|
|
|
1681
1681
|
___
|
|
1682
1682
|
|
|
@@ -694,7 +694,9 @@ function MealsTable() {
|
|
|
694
694
|
filtering: true, // Enable filtering
|
|
695
695
|
search: true,
|
|
696
696
|
pagination: true,
|
|
697
|
-
sorting: true
|
|
697
|
+
sorting: true,
|
|
698
|
+
export: true, // Enable export
|
|
699
|
+
import: true // Enable import
|
|
698
700
|
}}
|
|
699
701
|
rbac={{
|
|
700
702
|
pageName: 'meals'
|
|
@@ -1227,6 +1229,159 @@ function UserManagement() {
|
|
|
1227
1229
|
}
|
|
1228
1230
|
```
|
|
1229
1231
|
|
|
1232
|
+
## Export and Import
|
|
1233
|
+
|
|
1234
|
+
DataTable provides seamless CSV export and import functionality with automatic column mapping and support for reference fields.
|
|
1235
|
+
|
|
1236
|
+
### Basic Export/Import
|
|
1237
|
+
|
|
1238
|
+
When `export: true` and `import: true` are enabled in features, the DataTable automatically provides export and import buttons in the toolbar.
|
|
1239
|
+
|
|
1240
|
+
**Export**:
|
|
1241
|
+
- Exports all visible columns (respects column visibility settings)
|
|
1242
|
+
- Exports filtered data (respects current filters/search)
|
|
1243
|
+
- Exports all rows across all pages (not just current page)
|
|
1244
|
+
- Filename is automatically generated from table title: `{title}_{date}.csv`
|
|
1245
|
+
|
|
1246
|
+
**Import**:
|
|
1247
|
+
- Automatically maps CSV column headers to table columns
|
|
1248
|
+
- Case-insensitive header matching
|
|
1249
|
+
- Supports both display names and field names
|
|
1250
|
+
|
|
1251
|
+
### Export/Import with Reference Fields
|
|
1252
|
+
|
|
1253
|
+
For columns that display related data (using `accessorFn` with `editAccessorKey`), the export includes both the display value and the ID value for seamless round-trip import/export.
|
|
1254
|
+
|
|
1255
|
+
#### Example: Reference Field Column
|
|
1256
|
+
|
|
1257
|
+
```tsx
|
|
1258
|
+
const columns = [
|
|
1259
|
+
{
|
|
1260
|
+
id: "meal_code",
|
|
1261
|
+
accessorKey: "meal_code",
|
|
1262
|
+
header: "Meal Code",
|
|
1263
|
+
},
|
|
1264
|
+
{
|
|
1265
|
+
id: "meal_type",
|
|
1266
|
+
// Display function - shows the related meal type name
|
|
1267
|
+
accessorFn: (row) => row.mealtype?.mealtype_name || 'N/A',
|
|
1268
|
+
header: "Type",
|
|
1269
|
+
// Database field for storing/importing the ID
|
|
1270
|
+
editAccessorKey: 'meal_mealtype_id',
|
|
1271
|
+
fieldType: 'select',
|
|
1272
|
+
fieldOptions: mealTypes.map(mt => ({
|
|
1273
|
+
value: mt.mealtype_id,
|
|
1274
|
+
label: mt.mealtype_name
|
|
1275
|
+
}))
|
|
1276
|
+
},
|
|
1277
|
+
{
|
|
1278
|
+
id: "meal_date",
|
|
1279
|
+
accessorKey: "meal_date",
|
|
1280
|
+
header: "Date",
|
|
1281
|
+
},
|
|
1282
|
+
];
|
|
1283
|
+
```
|
|
1284
|
+
|
|
1285
|
+
#### Export Behavior
|
|
1286
|
+
|
|
1287
|
+
When you export this table, you'll get CSV columns like:
|
|
1288
|
+
|
|
1289
|
+
```csv
|
|
1290
|
+
Meal Code,Type,Type (ID),Date
|
|
1291
|
+
ptry,Pantry,abc-123-uuid,2024-04-11
|
|
1292
|
+
11bf,Breakfast,def-456-uuid,2024-04-11
|
|
1293
|
+
```
|
|
1294
|
+
|
|
1295
|
+
**Notice**:
|
|
1296
|
+
- "Type" column contains the display value (e.g., "Pantry", "Breakfast")
|
|
1297
|
+
- "Type (ID)" column contains the actual ID value (e.g., UUID) for importing
|
|
1298
|
+
- Both columns are included automatically
|
|
1299
|
+
|
|
1300
|
+
#### Import Behavior
|
|
1301
|
+
|
|
1302
|
+
The import automatically recognizes and maps:
|
|
1303
|
+
|
|
1304
|
+
| CSV Header | Maps To | Description |
|
|
1305
|
+
|------------|---------|-------------|
|
|
1306
|
+
| `Type` | `meal_mealtype_id` | Display column header |
|
|
1307
|
+
| `Type (ID)` | `meal_mealtype_id` | ID column header |
|
|
1308
|
+
| `meal_mealtype_id` | `meal_mealtype_id` | Direct field name |
|
|
1309
|
+
|
|
1310
|
+
**Round-Trip Support**: You can export data, modify it in Excel/CSV, and re-import it - the IDs will be automatically mapped correctly.
|
|
1311
|
+
|
|
1312
|
+
#### Complete Example
|
|
1313
|
+
|
|
1314
|
+
```tsx
|
|
1315
|
+
<DataTable
|
|
1316
|
+
data={meals}
|
|
1317
|
+
columns={columns}
|
|
1318
|
+
features={{
|
|
1319
|
+
export: true,
|
|
1320
|
+
import: true,
|
|
1321
|
+
// ... other features
|
|
1322
|
+
}}
|
|
1323
|
+
onImport={async (importedData) => {
|
|
1324
|
+
// Imported data is already mapped to your column structure
|
|
1325
|
+
// Reference fields use the editAccessorKey value
|
|
1326
|
+
for (const meal of importedData) {
|
|
1327
|
+
await createMeal({
|
|
1328
|
+
meal_code: meal.meal_code,
|
|
1329
|
+
meal_mealtype_id: meal.meal_mealtype_id, // Automatically mapped
|
|
1330
|
+
meal_date: meal.meal_date,
|
|
1331
|
+
});
|
|
1332
|
+
}
|
|
1333
|
+
}}
|
|
1334
|
+
rbac={{
|
|
1335
|
+
pageName: 'meals'
|
|
1336
|
+
}}
|
|
1337
|
+
/>
|
|
1338
|
+
```
|
|
1339
|
+
|
|
1340
|
+
### Custom Export Filename
|
|
1341
|
+
|
|
1342
|
+
The export filename is automatically generated from the table `title` prop:
|
|
1343
|
+
|
|
1344
|
+
- If `title` is provided: `{title}_{date}.csv` (e.g., `meals_2024-04-11.csv`)
|
|
1345
|
+
- If no `title`: `data_export_{date}.csv`
|
|
1346
|
+
|
|
1347
|
+
To customize the filename, you can provide a custom `onExport` handler:
|
|
1348
|
+
|
|
1349
|
+
```tsx
|
|
1350
|
+
<DataTable
|
|
1351
|
+
title="Meals"
|
|
1352
|
+
columns={columns}
|
|
1353
|
+
features={{ export: true }}
|
|
1354
|
+
onExport={async () => {
|
|
1355
|
+
// Custom export logic
|
|
1356
|
+
const data = getFilteredData();
|
|
1357
|
+
await exportToCSV(data, columns, 'custom-export-name.csv');
|
|
1358
|
+
}}
|
|
1359
|
+
/>
|
|
1360
|
+
```
|
|
1361
|
+
|
|
1362
|
+
### Export Column Selection
|
|
1363
|
+
|
|
1364
|
+
**Important**: Only **visible columns** are exported. If a column is hidden (via column visibility controls), it will not be included in the export.
|
|
1365
|
+
|
|
1366
|
+
To ensure all columns are exported:
|
|
1367
|
+
- Make sure all desired columns are visible before exporting
|
|
1368
|
+
- Or use a custom `onExport` handler to export specific columns
|
|
1369
|
+
|
|
1370
|
+
### Import Column Mapping
|
|
1371
|
+
|
|
1372
|
+
The import automatically maps CSV columns using this priority:
|
|
1373
|
+
|
|
1374
|
+
1. **Column Header Match** (case-insensitive)
|
|
1375
|
+
- CSV header "Type" → maps to column with `header: "Type"`
|
|
1376
|
+
|
|
1377
|
+
2. **editAccessorKey Match** (for reference fields)
|
|
1378
|
+
- CSV header "Type" or "Type (ID)" → maps to `editAccessorKey` field
|
|
1379
|
+
|
|
1380
|
+
3. **accessorKey/id Match** (fallback)
|
|
1381
|
+
- CSV header matches column `accessorKey` or `id`
|
|
1382
|
+
|
|
1383
|
+
If no match is found, the CSV column name is used as-is (useful for new fields).
|
|
1384
|
+
|
|
1230
1385
|
### Form Integration
|
|
1231
1386
|
|
|
1232
1387
|
```tsx
|
package/package.json
CHANGED
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
* - ✅ **Pagination** - Configurable pagination with custom initial page size and page size options
|
|
26
26
|
* - ✅ **Sorting** - Multi-column sorting with visual indicators (↕️ unsorted, ↑ ascending, ↓ descending)
|
|
27
27
|
* - ✅ **Filtering** - Column-specific filtering with multiple input types
|
|
28
|
-
* - ✅ **Export/Import** - CSV
|
|
28
|
+
* - ✅ **Export/Import** - CSV data export/import with automatic column mapping and reference field support
|
|
29
29
|
* - ✅ **Row Selection** - Single and multi-row selection for bulk operations
|
|
30
30
|
* - ✅ **Row Creation** - Add new rows with validation
|
|
31
31
|
* - ✅ **Row Editing** - Inline row editing with input field conversion
|