synapse-react-client 4.0.7 → 4.0.8

package/dist/SWC.index.js

@@ -221,7 +221,7 @@ const Y = {
   sendSearchResultsReturnedEvent: y,
   sendSearchResultReturnedEvent: c,
   sendSearchResultClickedEvent: d
-}, tt = "4.0.7";
+}, tt = "4.0.8";
 export {
   $ as Analytics,
   g as HttpClient,

package/dist/components/DataGrid/DataGridTypes.d.ts

@@ -1,6 +1,7 @@
 import { ValidationResults } from '@sage-bionetworks/synapse-types';
 import { Model } from 'json-joy/lib/json-crdt';
 import { s } from 'json-joy/lib/json-crdt-patch';
+import type { ReplicaCategory } from './utils/getReplicaCategory';
 type SelectionMap = Record<string, ReturnType<typeof s.con<ReplicaSelectionModel>>>;
 export declare const gridSchema: import("json-joy").nodes.obj<{
     doc_version: import("json-joy").nodes.con<string>;
@@ -41,6 +42,10 @@ export interface QueryInput {
 }
 export type GridModel = ReturnType<typeof Model.create<typeof gridSchema>>;
 export type GridModelSnapshot = ReturnType<GridModel['api']['getSnapshot']>;
+export type CellChangeInfo = {
+    category: ReplicaCategory;
+    tooltipText: string;
+};
 export interface Operation {
     type: 'UPDATE' | 'DELETE' | 'CREATE';
     fromRowIndex: number;
@@ -51,14 +56,15 @@ export interface Operation {
  * This objects acts as a "ViewModel" and can be translated to/from the Synapse data grid CRDT schema.
  */
 export type DataGridRow = {
-    [key: string]: string | number | boolean | null | undefined;
-} & {
+    [key: string]: string | number | boolean | null | undefined | ValidationResults | Map<string, string[]> | Record<string, CellChangeInfo>;
     /** The JSON Schema validation results for the row, generated by the hub */
     __validationResults?: ValidationResults;
     /** The current status of the validation results, as computed by the client */
     __validationStatus?: 'valid' | 'invalid' | 'pending';
     /** The parsed validation messages for individual columns **/
     __cellValidationResults?: Map<string, string[]>;
+    /** Per-cell change attribution, keyed by column name */
+    __cellChangeInfo?: Record<string, CellChangeInfo>;
 };
 export {};
 //# sourceMappingURL=DataGridTypes.d.ts.map

package/dist/components/DataGrid/DataGridTypes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DataGridTypes.d.ts","sourceRoot":"","sources":["../../../src/components/DataGrid/DataGridTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AAC9C,OAAO,EAAE,CAAC,EAAE,MAAM,8BAA8B,CAAA;AAchD,KAAK,YAAY,GAAG,MAAM,CACxB,MAAM,EACN,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAChD,CAAA;AAGD,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;kDAMrB,CAAA;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,KAAK,GACL,WAAW,GACX,aAAa,GACb,SAAS,CAAA;AAEb,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,cAAc,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,UAAU,CAAC,CAAC,CAAA;AAC1E,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAA;AAE3E,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACpC,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAA;CAC5D,GAAG;IACF,2EAA2E;IAC3E,mBAAmB,CAAC,EAAE,iBAAiB,CAAA;IACvC,8EAA8E;IAC9E,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IACpD,6DAA6D;IAC7D,uBAAuB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAChD,CAAA"}
+{"version":3,"file":"DataGridTypes.d.ts","sourceRoot":"","sources":["../../../src/components/DataGrid/DataGridTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AAC9C,OAAO,EAAE,CAAC,EAAE,MAAM,8BAA8B,CAAA;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAcjE,KAAK,YAAY,GAAG,MAAM,CACxB,MAAM,EACN,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC,CAChD,CAAA;AAGD,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;kDAMrB,CAAA;AAEF,MAAM,MAAM,MAAM,GAAG;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,CAAA;AAED,MAAM,WAAW,cAAc;IAC7B,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,cAAc,GACtB,OAAO,GACP,KAAK,GACL,WAAW,GACX,aAAa,GACb,SAAS,CAAA;AAEb,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,cAAc,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,OAAO,KAAK,CAAC,MAAM,CAAC,OAAO,UAAU,CAAC,CAAC,CAAA;AAC1E,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,aAAa,CAAC,CAAC,CAAA;AAE3E,MAAM,MAAM,cAAc,GAAG;IAC3B,QAAQ,EAAE,eAAe,CAAA;IACzB,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACpC,YAAY,EAAE,MAAM,CAAA;IACpB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB,CAAC,GAAG,EAAE,MAAM,GACR,MAAM,GACN,MAAM,GACN,OAAO,GACP,IAAI,GACJ,SAAS,GACT,iBAAiB,GACjB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GACrB,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAClC,2EAA2E;IAC3E,mBAAmB,CAAC,EAAE,iBAAiB,CAAA;IACvC,8EAA8E;IAC9E,kBAAkB,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAAA;IACpD,6DAA6D;IAC7D,uBAAuB,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;IAC/C,wDAAwD;IACxD,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;CAClD,CAAA"}

package/dist/components/DataGrid/DataGridTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"DataGridTypes.js","sources":["../../../src/components/DataGrid/DataGridTypes.ts"],"sourcesContent":["import { ValidationResults } from '@sage-bionetworks/synapse-types'\nimport { Model } from 'json-joy/lib/json-crdt'\nimport { s } from 'json-joy/lib/json-crdt-patch'\n\nconst gridRowSchema = s.obj({\n  data: s.vec(s.con('')),\n  metadata: s.obj({\n    synapseRow: s.obj({\n      rowId: s.con(0),\n      versionNumber: s.con(0),\n      etag: s.con(''),\n    }),\n    rowValidation: s.con<ValidationResults | undefined>(undefined),\n  }),\n})\n\ntype SelectionMap = Record<\n  string,\n  ReturnType<typeof s.con<ReplicaSelectionModel>>\n>\nconst selectionSchema = s.obj<SelectionMap, SelectionMap>({})\n\nexport const gridSchema = s.obj({\n  doc_version: s.con('0.1.0'),\n  columnNames: s.vec(s.con('')),\n  columnOrder: s.arr([]),\n  selection: selectionSchema,\n  rows: s.arr<typeof gridRowSchema>([]),\n})\n\nexport type CrdtId = {\n  rep: number\n  seq: number\n}\n\nexport type ReplicaSelectionModel = {\n  columnSelection?: CrdtId[]\n  rowSelection?: CrdtId[]\n  columnSelectAll?: boolean\n  rowSelectAll?: boolean\n}\n\nexport interface JsonJoyMessage {\n  sequenceNumber: number\n  methodName: string\n  payload?: string\n}\n\nexport type QueryInputType =\n  | 'empty'\n  | 'sql'\n  | 'sessionId'\n  | 'recordSetId'\n  | 'unknown'\n\nexport interface QueryInput {\n  type: QueryInputType\n  input: string\n}\n\nexport type GridModel = ReturnType<typeof Model.create<typeof gridSchema>>\nexport type GridModelSnapshot = ReturnType<GridModel['api']['getSnapshot']>\n\nexport interface Operation {\n  type: 'UPDATE' | 'DELETE' | 'CREATE'\n  fromRowIndex: number\n  toRowIndex: number\n}\n\n/**\n * Object that represents a single row of data in a Grid session that is compatible with react-datasheet-grid.\n * This objects acts as a \"ViewModel\" and can be translated to/from the Synapse data grid CRDT schema.\n */\nexport type DataGridRow = {\n  [key: string]: string | number | boolean | null | undefined\n} & {\n  /** The JSON Schema validation results for the row, generated by the hub */\n  __validationResults?: ValidationResults\n  /** The current status of the validation results, as computed by the client */\n  __validationStatus?: 'valid' | 'invalid' | 'pending'\n  /** The parsed validation messages for individual columns **/\n  __cellValidationResults?: Map<string, string[]>\n}\n"],"names":["s","selectionSchema","gridSchema"],"mappings":";AAIsBA,EAAE,IAAI;AAAA,EAC1B,MAAMA,EAAE,IAAIA,EAAE,IAAI,EAAE,CAAC;AAAA,EACrB,UAAUA,EAAE,IAAI;AAAA,IACd,YAAYA,EAAE,IAAI;AAAA,MAChB,OAAOA,EAAE,IAAI,CAAC;AAAA,MACd,eAAeA,EAAE,IAAI,CAAC;AAAA,MACtB,MAAMA,EAAE,IAAI,EAAE;AAAA,IAAA,CACf;AAAA,IACD,eAAeA,EAAE,IAAmC,MAAS;AAAA,EAAA,CAC9D;AACH,CAAC;AAMD,MAAMC,IAAkBD,EAAE,IAAgC,EAAE,GAE/CE,IAAaF,EAAE,IAAI;AAAA,EAC9B,aAAaA,EAAE,IAAI,OAAO;AAAA,EAC1B,aAAaA,EAAE,IAAIA,EAAE,IAAI,EAAE,CAAC;AAAA,EAC5B,aAAaA,EAAE,IAAI,EAAE;AAAA,EACrB,WAAWC;AAAA,EACX,MAAMD,EAAE,IAA0B,CAAA,CAAE;AACtC,CAAC;"}
+{"version":3,"file":"DataGridTypes.js","sources":["../../../src/components/DataGrid/DataGridTypes.ts"],"sourcesContent":["import { ValidationResults } from '@sage-bionetworks/synapse-types'\nimport { Model } from 'json-joy/lib/json-crdt'\nimport { s } from 'json-joy/lib/json-crdt-patch'\nimport type { ReplicaCategory } from './utils/getReplicaCategory'\n\nconst gridRowSchema = s.obj({\n  data: s.vec(s.con('')),\n  metadata: s.obj({\n    synapseRow: s.obj({\n      rowId: s.con(0),\n      versionNumber: s.con(0),\n      etag: s.con(''),\n    }),\n    rowValidation: s.con<ValidationResults | undefined>(undefined),\n  }),\n})\n\ntype SelectionMap = Record<\n  string,\n  ReturnType<typeof s.con<ReplicaSelectionModel>>\n>\nconst selectionSchema = s.obj<SelectionMap, SelectionMap>({})\n\nexport const gridSchema = s.obj({\n  doc_version: s.con('0.1.0'),\n  columnNames: s.vec(s.con('')),\n  columnOrder: s.arr([]),\n  selection: selectionSchema,\n  rows: s.arr<typeof gridRowSchema>([]),\n})\n\nexport type CrdtId = {\n  rep: number\n  seq: number\n}\n\nexport type ReplicaSelectionModel = {\n  columnSelection?: CrdtId[]\n  rowSelection?: CrdtId[]\n  columnSelectAll?: boolean\n  rowSelectAll?: boolean\n}\n\nexport interface JsonJoyMessage {\n  sequenceNumber: number\n  methodName: string\n  payload?: string\n}\n\nexport type QueryInputType =\n  | 'empty'\n  | 'sql'\n  | 'sessionId'\n  | 'recordSetId'\n  | 'unknown'\n\nexport interface QueryInput {\n  type: QueryInputType\n  input: string\n}\n\nexport type GridModel = ReturnType<typeof Model.create<typeof gridSchema>>\nexport type GridModelSnapshot = ReturnType<GridModel['api']['getSnapshot']>\n\nexport type CellChangeInfo = {\n  category: ReplicaCategory\n  tooltipText: string\n}\n\nexport interface Operation {\n  type: 'UPDATE' | 'DELETE' | 'CREATE'\n  fromRowIndex: number\n  toRowIndex: number\n}\n\n/**\n * Object that represents a single row of data in a Grid session that is compatible with react-datasheet-grid.\n * This objects acts as a \"ViewModel\" and can be translated to/from the Synapse data grid CRDT schema.\n */\nexport type DataGridRow = {\n  [key: string]:\n    | string\n    | number\n    | boolean\n    | null\n    | undefined\n    | ValidationResults\n    | Map<string, string[]>\n    | Record<string, CellChangeInfo>\n  /** The JSON Schema validation results for the row, generated by the hub */\n  __validationResults?: ValidationResults\n  /** The current status of the validation results, as computed by the client */\n  __validationStatus?: 'valid' | 'invalid' | 'pending'\n  /** The parsed validation messages for individual columns **/\n  __cellValidationResults?: Map<string, string[]>\n  /** Per-cell change attribution, keyed by column name */\n  __cellChangeInfo?: Record<string, CellChangeInfo>\n}\n"],"names":["s","selectionSchema","gridSchema"],"mappings":";AAKsBA,EAAE,IAAI;AAAA,EAC1B,MAAMA,EAAE,IAAIA,EAAE,IAAI,EAAE,CAAC;AAAA,EACrB,UAAUA,EAAE,IAAI;AAAA,IACd,YAAYA,EAAE,IAAI;AAAA,MAChB,OAAOA,EAAE,IAAI,CAAC;AAAA,MACd,eAAeA,EAAE,IAAI,CAAC;AAAA,MACtB,MAAMA,EAAE,IAAI,EAAE;AAAA,IAAA,CACf;AAAA,IACD,eAAeA,EAAE,IAAmC,MAAS;AAAA,EAAA,CAC9D;AACH,CAAC;AAMD,MAAMC,IAAkBD,EAAE,IAAgC,EAAE,GAE/CE,IAAaF,EAAE,IAAI;AAAA,EAC9B,aAAaA,EAAE,IAAI,OAAO;AAAA,EAC1B,aAAaA,EAAE,IAAIA,EAAE,IAAI,EAAE,CAAC;AAAA,EAC5B,aAAaA,EAAE,IAAI,EAAE;AAAA,EACrB,WAAWC;AAAA,EACX,MAAMD,EAAE,IAA0B,CAAA,CAAE;AACtC,CAAC;"}

package/dist/components/DataGrid/SynapseGrid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SynapseGrid.d.ts","sourceRoot":"","sources":["../../../src/components/DataGrid/SynapseGrid.tsx"],"names":[],"mappings":"AAaA,OAAO,EACL,iBAAiB,EAElB,MAAM,kCAAkC,CAAA;AA4BzC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,CAAA;IACpD,mBAAmB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAA;CACjD,CAAA;AAED,QAAA,MAAM,WAAW,gHAudhB,CAAA;AAED,eAAe,WAAW,CAAA"}
+{"version":3,"file":"SynapseGrid.d.ts","sourceRoot":"","sources":["../../../src/components/DataGrid/SynapseGrid.tsx"],"names":[],"mappings":"AAaA,OAAO,EACL,iBAAiB,EAElB,MAAM,kCAAkC,CAAA;AA8BzC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc,EAAE,CAAC,OAAO,EAAE,iBAAiB,KAAK,IAAI,CAAA;IACpD,mBAAmB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAA;CACjD,CAAA;AAED,QAAA,MAAM,WAAW,gHA6ehB,CAAA;AAED,eAAe,WAAW,CAAA"}