@vuu-ui/vuu-data-types 3.3.1 → 3.3.2

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.
Files changed (2) hide show
  1. package/index.d.ts +20 -0
  2. package/package.json +3 -3
package/index.d.ts CHANGED
@@ -454,6 +454,12 @@ export interface DataSourceConstructorProps extends WithBaseFilter<DataSourceCon
454
454
  * after an edit session is saved. Default is no additional column.
455
455
  */
456
456
  sessionTableMessageColumn?: string;
457
+ /**
458
+ * Describes the session (edit/import/export) table when it differs from `table`.
459
+ * Applied internally by `createSessionDataSource` / `beginEditSession` whenever
460
+ * a call does not supply its own `SessionDataSourceOverrides`.
461
+ */
462
+ session?: SessionDataSourceOverrides;
457
463
  suspenseProps?: DataSourceSuspenseProps;
458
464
  table: VuuTable;
459
465
  title?: string;
@@ -598,6 +604,18 @@ export declare type EditSessionMode =
598
604
  | "all-rows"
599
605
  | "empty-session-table";
600
606
 
607
+ /**
608
+ * Describes an edit (session) table whose schema differs from the source (view) table.
609
+ * When supplied, the session datasource is built from these values instead of inheriting
610
+ * the source datasource config, which would otherwise reference view-only columns.
611
+ */
612
+ export declare type SessionDataSourceOverrides = {
613
+ /** Columns to subscribe to on the session table. */
614
+ columns?: VuuColumns;
615
+ /** Expected session table. Used to validate the table returned by the server. */
616
+ table?: VuuTable;
617
+ };
618
+
601
619
  export interface EditApi<
602
620
  T extends DataSourceRow | DataSourceRowWithBigint = DataSourceRow,
603
621
  > {
@@ -622,12 +640,14 @@ export interface EditApi<
622
640
  createSessionDataSource?: (
623
641
  copyOption: CopyOption,
624
642
  sessionType?: SessionType,
643
+ overrides?: SessionDataSourceOverrides,
625
644
  ) => Promise<DataSource<T> | undefined>;
626
645
  /**
627
646
  * Legacy session creation API. Prefer createSessionDataSource for new servers.
628
647
  */
629
648
  beginEditSession?: (
630
649
  editSessionMode?: EditSessionMode,
650
+ overrides?: SessionDataSourceOverrides,
631
651
  ) => Promise<DataSource<T> | undefined>;
632
652
  endEditSession?: (
633
653
  saveChanges?: boolean,
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@vuu-ui/vuu-data-types",
3
- "version": "3.3.1",
3
+ "version": "3.3.2",
4
4
  "author": "heswell",
5
5
  "license": "Apache-2.0",
6
6
  "devDependencies": {
7
- "@vuu-ui/vuu-filter-types": "3.3.1",
8
- "@vuu-ui/vuu-protocol-types": "3.3.1"
7
+ "@vuu-ui/vuu-filter-types": "3.3.2",
8
+ "@vuu-ui/vuu-protocol-types": "3.3.2"
9
9
  },
10
10
  "dependencies": {},
11
11
  "peerDependencies": {},