@vuu-ui/vuu-data-types 2.1.10 → 2.1.12

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 +24 -10
  2. package/package.json +3 -3
package/index.d.ts CHANGED
@@ -437,6 +437,12 @@ export interface DataSourceConstructorProps
437
437
  */
438
438
  autosubscribeColumns?: string[];
439
439
  bufferSize?: number;
440
+ /**
441
+ * For datasources that support edit sessions, some services support an additional
442
+ * column on session tables that will be used to return status information for a row
443
+ * after an edit session is saved. Default is no additional column.
444
+ */
445
+ sessionTableMessageColumn?: string;
440
446
  suspenseProps?: DataSourceSuspenseProps;
441
447
  table: VuuTable;
442
448
  title?: string;
@@ -463,27 +469,30 @@ export declare type RowSelectionEventHandler = (
463
469
  selectedRowCount: number,
464
470
  ) => void;
465
471
 
466
- export type DataSourceConfigChangeHandler = (
472
+ export declare type DataSourceConfigChangeHandler = (
467
473
  config: ConfigWithVisualLink,
468
474
  range: Range,
469
475
  confirmed?: boolean,
470
476
  configChanges?: DataSourceConfigChanges,
471
477
  ) => void;
472
478
 
479
+ export declare type RemoteUpdateHandler = (rows: DataSourceRow[]) => void;
480
+
473
481
  export declare type DataSourceEvents = {
474
482
  config: DataSourceConfigChangeHandler;
483
+ disabled: DataSourceEventHandler;
484
+ enabled: DataSourceEventHandler;
475
485
  freeze: (isFrozen: boolean, freezeTimeStamp: number) => void;
476
486
  optimize: (optimize: OptimizeStrategy) => void;
477
487
  "page-count": (pageCount: number) => void;
478
488
  range: (range: Range) => void;
479
489
  resize: (size: number) => void;
490
+ resumed: DataSourceEventHandler;
491
+ "remote-update-during-local-edit": RemoteUpdateHandler;
480
492
  "row-selection": RowSelectionEventHandler;
481
493
  subscribed: (subscription: DataSourceSubscribedMessage) => void;
482
494
  unsubscribed: DataSourceEventHandler;
483
495
  suspended: DataSourceEventHandler;
484
- resumed: DataSourceEventHandler;
485
- disabled: DataSourceEventHandler;
486
- enabled: DataSourceEventHandler;
487
496
  "title-changed": (id: string, title: string) => void;
488
497
  "visual-link-created": (message: DataSourceVisualLinkCreatedMessage) => void;
489
498
  "visual-link-removed": () => void;
@@ -528,7 +537,7 @@ export declare type DataSourceStatus =
528
537
  export declare type SuggestionFetcher = (
529
538
  params: TypeaheadParams,
530
539
  ) => Promise<string[] | false>;
531
- export type SuggestionProvider = () => SuggestionFetcher;
540
+ export declare type SuggestionProvider = () => SuggestionFetcher;
532
541
 
533
542
  export interface TypeaheadSuggestionProvider {
534
543
  getTypeaheadSuggestions: (
@@ -550,16 +559,18 @@ export declare type DataSourceSuspenseProps = {
550
559
  * An inline edit session allows user to apply edits directly to
551
560
  * the existing component. e.g. directly edit cells within a table.
552
561
  */
553
- export type InlineEditSessionMode = "inline-all-rows";
562
+ export declare type InlineEditSessionMode = "inline-all-rows";
554
563
  /**
555
564
  * A standalone edit session re-renders editable data in an edit component.
556
565
  * e.g an edit panel may be displayed in a dialog.
557
566
  */
558
- export type StandaloneEditSessionMode =
567
+ export declare type StandaloneEditSessionMode =
559
568
  | "selected-rows"
560
569
  | "all-rows"
561
570
  | "empty-session-table";
562
- export type EditSessionMode = InlineEditSessionMode | StandaloneEditSessionMode;
571
+ export declare type EditSessionMode =
572
+ | InlineEditSessionMode
573
+ | StandaloneEditSessionMode;
563
574
 
564
575
  export interface EditApi {
565
576
  beginEditSession?: (
@@ -570,7 +581,10 @@ export interface EditApi {
570
581
  colun: string,
571
582
  value: VuuRowDataItemType,
572
583
  ) => Promise<RpcResult> | undefined;
573
- endEditSession?: (saveChanges?: boolean) => Promise<RpcResult> | undefined;
584
+ endEditSession?: (
585
+ saveChanges?: boolean,
586
+ force?: boolean,
587
+ ) => Promise<RpcResult> | undefined;
574
588
  }
575
589
 
576
590
  export interface DataSource
@@ -962,7 +976,7 @@ export declare type VuuUIMessageOut =
962
976
  | WithRequestId<VuuTableListRequest | VuuTableMetaRequest>
963
977
  | SelectRequest;
964
978
 
965
- export type ConnectOptions = {
979
+ export declare type ConnectOptions = {
966
980
  url: string;
967
981
  token: string;
968
982
  protocol?: WebSocketProtocol;
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@vuu-ui/vuu-data-types",
3
- "version": "2.1.10",
3
+ "version": "2.1.12",
4
4
  "author": "heswell",
5
5
  "license": "Apache-2.0",
6
6
  "devDependencies": {
7
- "@vuu-ui/vuu-filter-types": "2.1.10",
8
- "@vuu-ui/vuu-protocol-types": "2.1.10"
7
+ "@vuu-ui/vuu-filter-types": "2.1.12",
8
+ "@vuu-ui/vuu-protocol-types": "2.1.12"
9
9
  },
10
10
  "dependencies": {},
11
11
  "peerDependencies": {},