@platforma-sdk/model 1.53.14 → 1.54.7

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 (142) hide show
  1. package/dist/annotations/converter.cjs +8 -32
  2. package/dist/annotations/converter.cjs.map +1 -1
  3. package/dist/annotations/converter.d.ts.map +1 -1
  4. package/dist/annotations/converter.js +7 -31
  5. package/dist/annotations/converter.js.map +1 -1
  6. package/dist/block_model.cjs +1 -0
  7. package/dist/block_model.cjs.map +1 -1
  8. package/dist/block_model.d.ts.map +1 -1
  9. package/dist/block_model.js +1 -0
  10. package/dist/block_model.js.map +1 -1
  11. package/dist/builder.cjs +1 -0
  12. package/dist/builder.cjs.map +1 -1
  13. package/dist/builder.d.ts.map +1 -1
  14. package/dist/builder.js +1 -0
  15. package/dist/builder.js.map +1 -1
  16. package/dist/components/PlDataTable/index.d.ts +5 -0
  17. package/dist/components/PlDataTable/index.d.ts.map +1 -0
  18. package/dist/components/PlDataTable/labels.cjs +91 -0
  19. package/dist/components/PlDataTable/labels.cjs.map +1 -0
  20. package/dist/components/PlDataTable/labels.d.ts +7 -0
  21. package/dist/components/PlDataTable/labels.d.ts.map +1 -0
  22. package/dist/components/PlDataTable/labels.js +88 -0
  23. package/dist/components/PlDataTable/labels.js.map +1 -0
  24. package/dist/components/PlDataTable/state-migration.cjs +162 -0
  25. package/dist/components/PlDataTable/state-migration.cjs.map +1 -0
  26. package/dist/components/PlDataTable/state-migration.d.ts +94 -0
  27. package/dist/components/PlDataTable/state-migration.d.ts.map +1 -0
  28. package/dist/components/PlDataTable/state-migration.js +158 -0
  29. package/dist/components/PlDataTable/state-migration.js.map +1 -0
  30. package/dist/components/PlDataTable/table.cjs +188 -0
  31. package/dist/components/PlDataTable/table.cjs.map +1 -0
  32. package/dist/components/PlDataTable/table.d.ts +26 -0
  33. package/dist/components/PlDataTable/table.d.ts.map +1 -0
  34. package/dist/components/PlDataTable/table.js +184 -0
  35. package/dist/components/PlDataTable/table.js.map +1 -0
  36. package/dist/components/PlDataTable/v4.d.ts +157 -0
  37. package/dist/components/PlDataTable/v4.d.ts.map +1 -0
  38. package/dist/components/PlDataTable/v5.d.ts +113 -0
  39. package/dist/components/PlDataTable/v5.d.ts.map +1 -0
  40. package/dist/filters/converters/filterEmpty.cjs +49 -0
  41. package/dist/filters/converters/filterEmpty.cjs.map +1 -0
  42. package/dist/filters/converters/filterEmpty.d.ts +4 -0
  43. package/dist/filters/converters/filterEmpty.d.ts.map +1 -0
  44. package/dist/filters/converters/filterEmpty.js +46 -0
  45. package/dist/filters/converters/filterEmpty.js.map +1 -0
  46. package/dist/filters/converters/filterToQuery.cjs +244 -0
  47. package/dist/filters/converters/filterToQuery.cjs.map +1 -0
  48. package/dist/filters/converters/filterToQuery.d.ts +4 -0
  49. package/dist/filters/converters/filterToQuery.d.ts.map +1 -0
  50. package/dist/filters/converters/filterToQuery.js +242 -0
  51. package/dist/filters/converters/filterToQuery.js.map +1 -0
  52. package/dist/filters/{converter.cjs → converters/filterUiToExpressionImpl.cjs} +3 -2
  53. package/dist/filters/converters/filterUiToExpressionImpl.cjs.map +1 -0
  54. package/dist/filters/{converter.d.ts → converters/filterUiToExpressionImpl.d.ts} +2 -2
  55. package/dist/filters/converters/filterUiToExpressionImpl.d.ts.map +1 -0
  56. package/dist/filters/{converter.js → converters/filterUiToExpressionImpl.js} +3 -2
  57. package/dist/filters/converters/filterUiToExpressionImpl.js.map +1 -0
  58. package/dist/filters/converters/index.d.ts +3 -0
  59. package/dist/filters/converters/index.d.ts.map +1 -0
  60. package/dist/filters/distill.cjs +46 -0
  61. package/dist/filters/distill.cjs.map +1 -0
  62. package/dist/filters/distill.d.ts +6 -0
  63. package/dist/filters/distill.d.ts.map +1 -0
  64. package/dist/filters/distill.js +44 -0
  65. package/dist/filters/distill.js.map +1 -0
  66. package/dist/filters/index.d.ts +2 -1
  67. package/dist/filters/index.d.ts.map +1 -1
  68. package/dist/filters/types.d.ts +1 -117
  69. package/dist/filters/types.d.ts.map +1 -1
  70. package/dist/index.cjs +17 -15
  71. package/dist/index.cjs.map +1 -1
  72. package/dist/index.js +5 -2
  73. package/dist/index.js.map +1 -1
  74. package/dist/package.json.cjs +1 -1
  75. package/dist/package.json.js +1 -1
  76. package/dist/pframe_utils/columns.cjs +2 -0
  77. package/dist/pframe_utils/columns.cjs.map +1 -1
  78. package/dist/pframe_utils/columns.js +2 -0
  79. package/dist/pframe_utils/columns.js.map +1 -1
  80. package/dist/pframe_utils/index.cjs +2 -0
  81. package/dist/pframe_utils/index.cjs.map +1 -1
  82. package/dist/pframe_utils/index.js +2 -0
  83. package/dist/pframe_utils/index.js.map +1 -1
  84. package/dist/pframe_utils/querySpec.d.ts +2 -0
  85. package/dist/pframe_utils/querySpec.d.ts.map +1 -0
  86. package/dist/render/api.cjs +7 -0
  87. package/dist/render/api.cjs.map +1 -1
  88. package/dist/render/api.d.ts +3 -2
  89. package/dist/render/api.d.ts.map +1 -1
  90. package/dist/render/api.js +8 -1
  91. package/dist/render/api.js.map +1 -1
  92. package/dist/render/future.d.ts +1 -1
  93. package/dist/render/index.d.ts +2 -1
  94. package/dist/render/index.d.ts.map +1 -1
  95. package/dist/render/internal.cjs.map +1 -1
  96. package/dist/render/internal.d.ts +4 -1
  97. package/dist/render/internal.d.ts.map +1 -1
  98. package/dist/render/internal.js.map +1 -1
  99. package/dist/render/util/column_collection.cjs.map +1 -1
  100. package/dist/render/util/column_collection.d.ts +1 -1
  101. package/dist/render/util/column_collection.d.ts.map +1 -1
  102. package/dist/render/util/column_collection.js.map +1 -1
  103. package/dist/render/util/pcolumn_data.cjs.map +1 -1
  104. package/dist/render/util/pcolumn_data.d.ts +1 -1
  105. package/dist/render/util/pcolumn_data.d.ts.map +1 -1
  106. package/dist/render/util/pcolumn_data.js.map +1 -1
  107. package/package.json +9 -8
  108. package/src/annotations/converter.ts +12 -40
  109. package/src/block_model.ts +1 -0
  110. package/src/builder.ts +1 -0
  111. package/src/components/PlDataTable/index.ts +22 -0
  112. package/src/components/PlDataTable/labels.ts +101 -0
  113. package/src/components/PlDataTable/state-migration.ts +285 -0
  114. package/src/components/PlDataTable/table.ts +279 -0
  115. package/src/components/PlDataTable/v4.ts +193 -0
  116. package/src/components/PlDataTable/v5.ts +140 -0
  117. package/src/filters/converters/filterEmpty.test.ts +125 -0
  118. package/src/filters/converters/filterEmpty.ts +57 -0
  119. package/src/filters/converters/filterToQuery.test.ts +417 -0
  120. package/src/filters/converters/filterToQuery.ts +258 -0
  121. package/src/filters/{converter.test.ts → converters/filterUiToExpressionImpl.test.ts} +2 -2
  122. package/src/filters/{converter.ts → converters/filterUiToExpressionImpl.ts} +3 -2
  123. package/src/filters/converters/index.ts +2 -0
  124. package/src/filters/distill.ts +59 -0
  125. package/src/filters/index.ts +2 -1
  126. package/src/filters/types.ts +8 -48
  127. package/src/pframe_utils/querySpec.ts +1 -0
  128. package/src/render/api.ts +13 -6
  129. package/src/render/index.ts +2 -1
  130. package/src/render/internal.ts +11 -0
  131. package/src/render/util/column_collection.ts +1 -1
  132. package/src/render/util/pcolumn_data.ts +1 -1
  133. package/dist/components/PlDataTable.cjs +0 -307
  134. package/dist/components/PlDataTable.cjs.map +0 -1
  135. package/dist/components/PlDataTable.d.ts +0 -366
  136. package/dist/components/PlDataTable.d.ts.map +0 -1
  137. package/dist/components/PlDataTable.js +0 -297
  138. package/dist/components/PlDataTable.js.map +0 -1
  139. package/dist/filters/converter.cjs.map +0 -1
  140. package/dist/filters/converter.d.ts.map +0 -1
  141. package/dist/filters/converter.js.map +0 -1
  142. package/src/components/PlDataTable.ts +0 -794
@@ -1,794 +0,0 @@
1
- import type {
2
- AxisId,
3
- AxisSpec,
4
- CanonicalizedJson,
5
- DataInfo,
6
- ListOptionBase,
7
- PColumn,
8
- PColumnIdAndSpec,
9
- PColumnValues,
10
- PObjectId,
11
- PTableColumnId,
12
- PTableColumnIdAxis,
13
- PTableColumnIdColumn,
14
- PTableColumnSpec,
15
- PTableDef,
16
- PTableHandle,
17
- PTableRecordFilter,
18
- PTableRecordSingleValueFilterV2,
19
- PTableSorting,
20
- } from "@milaboratories/pl-model-common";
21
- import {
22
- Annotation,
23
- canonicalizeJson,
24
- getAxisId,
25
- getColumnIdAndSpec,
26
- isLabelColumn,
27
- isLinkerColumn,
28
- matchAxisId,
29
- PColumnName,
30
- readAnnotation,
31
- uniqueBy,
32
- } from "@milaboratories/pl-model-common";
33
- import type {
34
- AxisLabelProvider,
35
- ColumnProvider,
36
- PColumnDataUniversal,
37
- RenderCtxBase,
38
- TreeNodeAccessor,
39
- } from "../render";
40
- import { allPColumnsReady, deriveLabels, PColumnCollection } from "../render";
41
- import { identity } from "es-toolkit";
42
-
43
- export type PlTableColumnId = {
44
- /** Original column spec */
45
- source: PTableColumnSpec;
46
- /** Column spec with labeled axes replaced by label columns */
47
- labeled: PTableColumnSpec;
48
- };
49
-
50
- export type PlTableColumnIdJson = CanonicalizedJson<PlTableColumnId>;
51
-
52
- export type PlDataTableGridStateCore = {
53
- /** Includes column ordering */
54
- columnOrder?: {
55
- /** All colIds in order */
56
- orderedColIds: PlTableColumnIdJson[];
57
- };
58
- /** Includes current sort columns and direction */
59
- sort?: {
60
- /** Sorted columns and directions in order */
61
- sortModel: {
62
- /** Column Id to apply the sort to. */
63
- colId: PlTableColumnIdJson;
64
- /** Sort direction */
65
- sort: "asc" | "desc";
66
- }[];
67
- };
68
- /** Includes column visibility */
69
- columnVisibility?: {
70
- /** All colIds which were hidden */
71
- hiddenColIds: PlTableColumnIdJson[];
72
- };
73
- };
74
-
75
- export type PlDataTableSheet = {
76
- /** spec of the axis to use */
77
- axis: AxisSpec;
78
- /** options to show in the filter dropdown */
79
- options: ListOptionBase<string | number>[];
80
- /** default (selected) value */
81
- defaultValue?: string | number;
82
- };
83
-
84
- export type PlDataTableSheetState = {
85
- /** id of the axis */
86
- axisId: AxisId;
87
- /** selected value */
88
- value: string | number;
89
- };
90
-
91
- /**
92
- * PlDataTableV2 persisted state
93
- */
94
- export type PlDataTableStateV2 =
95
- // Old versions of the state
96
- | {
97
- // no version
98
- gridState: {
99
- columnOrder?: {
100
- orderedColIds: CanonicalizedJson<PTableColumnSpec>[];
101
- };
102
- sort?: {
103
- sortModel: {
104
- colId: CanonicalizedJson<PTableColumnSpec>;
105
- sort: "asc" | "desc";
106
- }[];
107
- };
108
- columnVisibility?: {
109
- hiddenColIds: CanonicalizedJson<PTableColumnSpec>[];
110
- };
111
- sourceId?: string;
112
- sheets?: Record<CanonicalizedJson<AxisId>, string | number>;
113
- };
114
- pTableParams?: {
115
- sorting?: PTableSorting[];
116
- filters?: PTableRecordFilter[];
117
- };
118
- }
119
- | {
120
- version: 2;
121
- stateCache: {
122
- sourceId: string;
123
- gridState: {
124
- columnOrder?: {
125
- orderedColIds: CanonicalizedJson<PTableColumnSpec>[];
126
- };
127
- sort?: {
128
- sortModel: {
129
- colId: CanonicalizedJson<PTableColumnSpec>;
130
- sort: "asc" | "desc";
131
- }[];
132
- };
133
- columnVisibility?: {
134
- hiddenColIds: CanonicalizedJson<PTableColumnSpec>[];
135
- };
136
- };
137
- sheetsState: PlDataTableSheetState[];
138
- }[];
139
- pTableParams: {
140
- hiddenColIds: PObjectId[] | null;
141
- filters: PTableRecordFilter[];
142
- sorting: PTableSorting[];
143
- };
144
- }
145
- | {
146
- version: 3;
147
- stateCache: {
148
- sourceId: string;
149
- gridState: {
150
- columnOrder?: {
151
- orderedColIds: CanonicalizedJson<PTableColumnSpec>[];
152
- };
153
- sort?: {
154
- sortModel: {
155
- colId: CanonicalizedJson<PTableColumnSpec>;
156
- sort: "asc" | "desc";
157
- }[];
158
- };
159
- columnVisibility?: {
160
- hiddenColIds: CanonicalizedJson<PTableColumnSpec>[];
161
- };
162
- };
163
- sheetsState: PlDataTableSheetState[];
164
- filtersState: PlDataTableFilterState[];
165
- }[];
166
- pTableParams: PTableParamsV2;
167
- }
168
- // Normalized state
169
- | PlDataTableStateV2Normalized;
170
-
171
- export type PlDataTableStateV2CacheEntry = {
172
- /** DataSource identifier for state management */
173
- sourceId: string;
174
- /** Internal ag-grid state */
175
- gridState: PlDataTableGridStateCore;
176
- /** Sheets state */
177
- sheetsState: PlDataTableSheetState[];
178
- /** Filters state */
179
- filtersState: PlDataTableFilterState[];
180
- };
181
-
182
- export type PTableParamsV2 =
183
- | {
184
- sourceId: null;
185
- hiddenColIds: null;
186
- partitionFilters: [];
187
- filters: [];
188
- sorting: [];
189
- }
190
- | {
191
- sourceId: string;
192
- hiddenColIds: PObjectId[] | null;
193
- partitionFilters: PTableRecordFilter[];
194
- filters: PTableRecordFilter[];
195
- sorting: PTableSorting[];
196
- };
197
-
198
- export type PlDataTableStateV2Normalized = {
199
- /** Version for upgrades */
200
- version: 4;
201
- /** Internal states, LRU cache for 5 sourceId-s */
202
- stateCache: PlDataTableStateV2CacheEntry[];
203
- /** PTable params derived from the cache state for the current sourceId */
204
- pTableParams: PTableParamsV2;
205
- };
206
-
207
- export function makeDefaultPTableParams(): PTableParamsV2 {
208
- return {
209
- sourceId: null,
210
- hiddenColIds: null,
211
- partitionFilters: [],
212
- filters: [],
213
- sorting: [],
214
- };
215
- }
216
-
217
- /** Create default PlDataTableStateV2 */
218
- export function createPlDataTableStateV2(): PlDataTableStateV2Normalized {
219
- return {
220
- version: 4,
221
- stateCache: [],
222
- pTableParams: makeDefaultPTableParams(),
223
- };
224
- }
225
-
226
- /** Upgrade PlDataTableStateV2 to the latest version */
227
- export function upgradePlDataTableStateV2(
228
- state: PlDataTableStateV2 | undefined,
229
- ): PlDataTableStateV2Normalized {
230
- // Block just added, had no state, model started earlier than the UI
231
- if (!state) {
232
- return createPlDataTableStateV2();
233
- }
234
- // v1 -> v2
235
- if (!("version" in state)) {
236
- // Non upgradeable as sourceId calculation algorithm has changed, resetting state to default
237
- state = createPlDataTableStateV2();
238
- }
239
- // v2 -> v3
240
- if (state.version === 2) {
241
- state = {
242
- version: 3,
243
- stateCache: state.stateCache.map((entry) => ({
244
- ...entry,
245
- filtersState: [],
246
- })),
247
- pTableParams: makeDefaultPTableParams(),
248
- };
249
- }
250
- // v3 -> v4
251
- if (state.version === 3) {
252
- // Non upgradeable as column ids calculation algorithm has changed, resetting state to default
253
- state = createPlDataTableStateV2();
254
- }
255
- return state;
256
- }
257
-
258
- export type PlDataTableFilterState = {
259
- id: PTableColumnId;
260
- alphabetic: boolean;
261
- filter: null | {
262
- value: PlTableFilter;
263
- disabled: boolean;
264
- };
265
- };
266
-
267
- /** PlTableFilters filter entry */
268
- export type PlTableFilterIsNotNA = {
269
- /** Predicate type */
270
- type: "isNotNA";
271
- };
272
-
273
- /** PlTableFilters filter entry */
274
- export type PlTableFilterIsNA = {
275
- /** Predicate type */
276
- type: "isNA";
277
- };
278
-
279
- /** PlTableFilters filter entries applicable to both string and number values */
280
- export type PlTableFilterCommon = PlTableFilterIsNotNA | PlTableFilterIsNA;
281
-
282
- /** PlTableFilters numeric filter entry */
283
- export type PlTableFilterNumberEquals = {
284
- /** Predicate type */
285
- type: "number_equals";
286
- /** Reference value */
287
- reference: number;
288
- };
289
-
290
- /** PlTableFilters numeric filter entry */
291
- export type PlTableFilterNumberNotEquals = {
292
- /** Predicate type */
293
- type: "number_notEquals";
294
- /** Reference value */
295
- reference: number;
296
- };
297
-
298
- /** PlTableFilters numeric filter entry */
299
- export type PlTableFilterNumberGreaterThan = {
300
- /** Predicate type */
301
- type: "number_greaterThan";
302
- /** Reference value */
303
- reference: number;
304
- };
305
-
306
- /** PlTableFilters numeric filter entry */
307
- export type PlTableFilterNumberGreaterThanOrEqualTo = {
308
- /** Predicate type */
309
- type: "number_greaterThanOrEqualTo";
310
- /** Reference value */
311
- reference: number;
312
- };
313
-
314
- /** PlTableFilters numeric filter entry */
315
- export type PlTableFilterNumberLessThan = {
316
- /** Predicate type */
317
- type: "number_lessThan";
318
- /** Reference value */
319
- reference: number;
320
- };
321
-
322
- /** PlTableFilters numeric filter entry */
323
- export type PlTableFilterNumberLessThanOrEqualTo = {
324
- /** Predicate type */
325
- type: "number_lessThanOrEqualTo";
326
- /** Reference value */
327
- reference: number;
328
- };
329
-
330
- /** PlTableFilters numeric filter entry */
331
- export type PlTableFilterNumberBetween = {
332
- /** Predicate type */
333
- type: "number_between";
334
- /** Reference value for the lower bound */
335
- lowerBound: number;
336
- /** Defines whether values equal to lower bound reference value should be matched */
337
- includeLowerBound: boolean;
338
- /** Reference value for the upper bound */
339
- upperBound: number;
340
- /** Defines whether values equal to upper bound reference value should be matched */
341
- includeUpperBound: boolean;
342
- };
343
-
344
- /** All PlTableFilters numeric filter entries */
345
- export type PlTableFilterNumber =
346
- | PlTableFilterCommon
347
- | PlTableFilterNumberEquals
348
- | PlTableFilterNumberNotEquals
349
- | PlTableFilterNumberGreaterThan
350
- | PlTableFilterNumberGreaterThanOrEqualTo
351
- | PlTableFilterNumberLessThan
352
- | PlTableFilterNumberLessThanOrEqualTo
353
- | PlTableFilterNumberBetween;
354
- /** All types of PlTableFilters numeric filter entries */
355
- export type PlTableFilterNumberType = PlTableFilterNumber["type"];
356
-
357
- /** PlTableFilters string filter entry */
358
- export type PlTableFilterStringEquals = {
359
- /** Predicate type */
360
- type: "string_equals";
361
- /** Reference value */
362
- reference: string;
363
- };
364
-
365
- /** PlTableFilters string filter entry */
366
- export type PlTableFilterStringNotEquals = {
367
- /** Predicate type */
368
- type: "string_notEquals";
369
- /** Reference value */
370
- reference: string;
371
- };
372
-
373
- /** PlTableFilters string filter entry */
374
- export type PlTableFilterStringContains = {
375
- /** Predicate type */
376
- type: "string_contains";
377
- /** Reference value */
378
- reference: string;
379
- };
380
-
381
- /** PlTableFilters string filter entry */
382
- export type PlTableFilterStringDoesNotContain = {
383
- /** Predicate type */
384
- type: "string_doesNotContain";
385
- /** Reference value */
386
- reference: string;
387
- };
388
-
389
- /** PlTableFilters string filter entry */
390
- export type PlTableFilterStringMatches = {
391
- /** Predicate type */
392
- type: "string_matches";
393
- /** Reference value */
394
- reference: string;
395
- };
396
-
397
- /** PlTableFilters string filter entry */
398
- export type PlTableFilterStringDoesNotMatch = {
399
- /** Predicate type */
400
- type: "string_doesNotMatch";
401
- /** Reference value */
402
- reference: string;
403
- };
404
-
405
- /** PlTableFilters string filter entry */
406
- export type PlTableFilterStringContainsFuzzyMatch = {
407
- /** Predicate type */
408
- type: "string_containsFuzzyMatch";
409
- /** Reference value */
410
- reference: string;
411
- /**
412
- * Maximum acceptable edit distance between reference value and matched substring
413
- * @see https://en.wikipedia.org/wiki/Edit_distance
414
- */
415
- maxEdits: number;
416
- /**
417
- * When {@link substitutionsOnly} is set to false
418
- * Levenshtein distance is used as edit distance (substitutions and indels)
419
- * @see https://en.wikipedia.org/wiki/Levenshtein_distance
420
- * When {@link substitutionsOnly} is set to true
421
- * Hamming distance is used as edit distance (substitutions only)
422
- * @see https://en.wikipedia.org/wiki/Hamming_distance
423
- */
424
- substitutionsOnly: boolean;
425
- /**
426
- * Single character in {@link reference} that will labelColumn any
427
- * single character in searched text.
428
- */
429
- wildcard?: string;
430
- };
431
-
432
- /** All PlTableFilters string filter entries */
433
- export type PlTableFilterString =
434
- | PlTableFilterCommon
435
- | PlTableFilterStringEquals
436
- | PlTableFilterStringNotEquals
437
- | PlTableFilterStringContains
438
- | PlTableFilterStringDoesNotContain
439
- | PlTableFilterStringMatches
440
- | PlTableFilterStringDoesNotMatch
441
- | PlTableFilterStringContainsFuzzyMatch;
442
- /** All types of PlTableFilters string filter entries */
443
- export type PlTableFilterStringType = PlTableFilterString["type"];
444
-
445
- /** All PlTableFilters filter entries */
446
- export type PlTableFilter = PlTableFilterNumber | PlTableFilterString;
447
- /** All types of PlTableFilters filter entries */
448
- export type PlTableFilterType = PlTableFilter["type"];
449
-
450
- export type CreatePlDataTableOps = {
451
- /** Filters for columns and non-partitioned axes */
452
- filters?: PTableRecordFilter[];
453
-
454
- /** Sorting to columns hidden from user */
455
- sorting?: PTableSorting[];
456
-
457
- /**
458
- * Selects columns for which will be inner-joined to the table.
459
- *
460
- * Default behaviour: all columns are considered to be core
461
- */
462
- coreColumnPredicate?: (spec: PColumnIdAndSpec) => boolean;
463
-
464
- /**
465
- * Determines how core columns should be joined together:
466
- * inner - so user will only see records present in all core columns
467
- * full - so user will only see records present in any of the core columns
468
- *
469
- * All non-core columns will be left joined to the table produced by the core
470
- * columns, in other words records form the pool of non-core columns will only
471
- * make their way into the final table if core table contains corresponding key.
472
- *
473
- * Default: 'full'
474
- */
475
- coreJoinType?: "inner" | "full";
476
- };
477
-
478
- /** Get all label columns from the result pool */
479
- export function getAllLabelColumns(
480
- resultPool: AxisLabelProvider & ColumnProvider,
481
- ): PColumn<PColumnDataUniversal>[] | undefined {
482
- return new PColumnCollection()
483
- .addAxisLabelProvider(resultPool)
484
- .addColumnProvider(resultPool)
485
- .getColumns(
486
- {
487
- name: PColumnName.Label,
488
- axes: [{}], // exactly one axis
489
- },
490
- { dontWaitAllData: true, overrideLabelAnnotation: false },
491
- );
492
- }
493
-
494
- /** Get label columns matching the provided columns from the result pool */
495
- export function getMatchingLabelColumns(
496
- columns: PColumnIdAndSpec[],
497
- allLabelColumns: PColumn<PColumnDataUniversal>[],
498
- ): PColumn<PColumnDataUniversal>[] {
499
- // split input columns into label and value columns
500
- const inputLabelColumns: typeof columns = [];
501
- const inputValueColumns: typeof columns = [];
502
- for (const column of columns) {
503
- if (isLabelColumn(column.spec)) {
504
- inputLabelColumns.push(column);
505
- } else {
506
- inputValueColumns.push(column);
507
- }
508
- }
509
-
510
- // collect distinct axes of value columns
511
- const unlabeledAxes: AxisId[] = [];
512
- for (const column of inputValueColumns) {
513
- for (const axis of column.spec.axesSpec) {
514
- const axisId = getAxisId(axis);
515
- if (!unlabeledAxes.some((id) => matchAxisId(id, axisId))) {
516
- unlabeledAxes.push(axisId);
517
- }
518
- }
519
- }
520
-
521
- // remove axes matched by input label columns
522
- for (const labelColumn of inputLabelColumns) {
523
- const labelAxisId = getAxisId(labelColumn.spec.axesSpec[0]);
524
- const labelMatch = unlabeledAxes.findIndex((axisId) => matchAxisId(axisId, labelAxisId));
525
- if (labelMatch !== -1) {
526
- unlabeledAxes.splice(labelMatch, 1);
527
- }
528
- }
529
-
530
- // warning: changing this id will break backward compatibility
531
- const colId = (id: PObjectId, domain?: Record<string, string>): PObjectId => {
532
- let wid = id.toString();
533
- if (domain) {
534
- for (const k in domain) {
535
- wid += k;
536
- wid += domain[k];
537
- }
538
- }
539
- return wid as PObjectId;
540
- };
541
-
542
- // search label columns for unmatched axes
543
- const labelColumns: typeof allLabelColumns = [];
544
- for (const labelColumn of allLabelColumns) {
545
- const labelAxis = labelColumn.spec.axesSpec[0];
546
- const labelAxisId = getAxisId(labelAxis);
547
- const labelMatch = unlabeledAxes.findIndex((axisId) => matchAxisId(axisId, labelAxisId));
548
- if (labelMatch !== -1) {
549
- const axisId = unlabeledAxes[labelMatch];
550
- const dataDomainLen = Object.keys(axisId.domain ?? {}).length;
551
- const labelDomainLen = Object.keys(labelAxis.domain ?? {}).length;
552
- if (dataDomainLen > labelDomainLen) {
553
- labelColumns.push({
554
- id: colId(labelColumn.id, axisId.domain),
555
- spec: {
556
- ...labelColumn.spec,
557
- axesSpec: [{ ...axisId, annotations: labelAxis.annotations }],
558
- },
559
- data: labelColumn.data,
560
- });
561
- } else {
562
- labelColumns.push(labelColumn);
563
- }
564
- unlabeledAxes.splice(labelMatch, 1);
565
- }
566
- }
567
- return labelColumns;
568
- }
569
-
570
- function createPTableDef(params: {
571
- columns: PColumn<PColumnDataUniversal>[];
572
- labelColumns: PColumn<PColumnDataUniversal>[];
573
- coreJoinType: "inner" | "full";
574
- partitionFilters: PTableRecordSingleValueFilterV2[];
575
- filters: PTableRecordSingleValueFilterV2[];
576
- sorting: PTableSorting[];
577
- coreColumnPredicate?: (spec: PColumnIdAndSpec) => boolean;
578
- }): PTableDef<PColumn<TreeNodeAccessor | PColumnValues | DataInfo<TreeNodeAccessor>>> {
579
- let coreColumns = params.columns;
580
- const secondaryColumns: typeof params.columns = [];
581
-
582
- if (params.coreColumnPredicate) {
583
- coreColumns = [];
584
- for (const c of params.columns)
585
- if (params.coreColumnPredicate(getColumnIdAndSpec(c))) coreColumns.push(c);
586
- else secondaryColumns.push(c);
587
- }
588
-
589
- secondaryColumns.push(...params.labelColumns);
590
-
591
- return {
592
- src: {
593
- type: "outer",
594
- primary: {
595
- type: params.coreJoinType,
596
- entries: coreColumns.map((c) => ({ type: "column", column: c })),
597
- },
598
- secondary: secondaryColumns.map((c) => ({ type: "column", column: c })),
599
- },
600
- partitionFilters: params.partitionFilters,
601
- filters: params.filters,
602
- sorting: params.sorting,
603
- };
604
- }
605
-
606
- /** PlAgDataTable model */
607
- export type PlDataTableModel = {
608
- /** DataSource identifier for state management */
609
- sourceId: string | null;
610
- /** p-table including all columns, used to show the full specification of the table */
611
- fullTableHandle: PTableHandle;
612
- /** p-table including only visible columns, used to get the data */
613
- visibleTableHandle: PTableHandle;
614
- };
615
-
616
- /** Check if column should be omitted from the table */
617
- export function isColumnHidden(spec: { annotations?: Annotation }): boolean {
618
- return readAnnotation(spec, Annotation.Table.Visibility) === "hidden";
619
- }
620
-
621
- /** Check if column is hidden by default */
622
- export function isColumnOptional(spec: { annotations?: Annotation }): boolean {
623
- return readAnnotation(spec, Annotation.Table.Visibility) === "optional";
624
- }
625
-
626
- /**
627
- * Create p-table spec and handle given ui table state
628
- *
629
- * @param ctx context
630
- * @param columns column list
631
- * @param tableState table ui state
632
- * @returns PlAgDataTableV2 table source
633
- */
634
- export function createPlDataTableV2<A, U>(
635
- ctx: RenderCtxBase<A, U>,
636
- columns: PColumn<PColumnDataUniversal>[],
637
- tableState: PlDataTableStateV2 | undefined,
638
- ops?: CreatePlDataTableOps,
639
- ): PlDataTableModel | undefined {
640
- if (columns.length === 0) return undefined;
641
-
642
- const tableStateNormalized = upgradePlDataTableStateV2(tableState);
643
-
644
- const allLabelColumns = getAllLabelColumns(ctx.resultPool);
645
- if (!allLabelColumns) return undefined;
646
-
647
- let fullLabelColumns = getMatchingLabelColumns(columns.map(getColumnIdAndSpec), allLabelColumns);
648
- fullLabelColumns = deriveLabels(fullLabelColumns, identity, { includeNativeLabel: true }).map(
649
- (v) => {
650
- return {
651
- ...v.value,
652
- spec: {
653
- ...v.value.spec,
654
- annotations: {
655
- ...v.value.spec.annotations,
656
- [Annotation.Label]: v.label,
657
- },
658
- },
659
- };
660
- },
661
- );
662
-
663
- const fullColumns = [...columns, ...fullLabelColumns];
664
-
665
- const fullColumnsAxes = uniqueBy(
666
- fullColumns.flatMap((c) => c.spec.axesSpec.map((a) => getAxisId(a))),
667
- (a) => canonicalizeJson<AxisId>(a),
668
- );
669
- const fullColumnsIds: PTableColumnId[] = [
670
- ...fullColumnsAxes.map((a) => ({ type: "axis", id: a }) satisfies PTableColumnIdAxis),
671
- ...fullColumns.map((c) => ({ type: "column", id: c.id }) satisfies PTableColumnIdColumn),
672
- ];
673
- const fullColumnsIdsSet = new Set(fullColumnsIds.map((c) => canonicalizeJson<PTableColumnId>(c)));
674
- const isValidColumnId = (id: PTableColumnId): boolean =>
675
- fullColumnsIdsSet.has(canonicalizeJson<PTableColumnId>(id));
676
-
677
- const coreJoinType = ops?.coreJoinType ?? "full";
678
- const partitionFilters: PTableRecordSingleValueFilterV2[] =
679
- tableStateNormalized.pTableParams.partitionFilters.filter((f) => {
680
- const valid = isValidColumnId(f.column);
681
- if (!valid)
682
- ctx.logWarn(
683
- `Partition filter ${JSON.stringify(f)} does not match provided columns, skipping`,
684
- );
685
- return valid;
686
- });
687
- const filters: PTableRecordSingleValueFilterV2[] = uniqueBy(
688
- [...tableStateNormalized.pTableParams.filters, ...(ops?.filters ?? [])],
689
- (f) => canonicalizeJson<PTableColumnId>(f.column),
690
- ).filter((f) => {
691
- const valid = isValidColumnId(f.column);
692
- if (!valid)
693
- ctx.logWarn(`Filter ${JSON.stringify(f)} does not match provided columns, skipping`);
694
- return valid;
695
- });
696
- const sorting: PTableSorting[] = uniqueBy(
697
- [...tableStateNormalized.pTableParams.sorting, ...(ops?.sorting ?? [])],
698
- (s) => canonicalizeJson<PTableColumnId>(s.column),
699
- ).filter((s) => {
700
- const valid = isValidColumnId(s.column);
701
- if (!valid)
702
- ctx.logWarn(`Sorting ${JSON.stringify(s)} does not match provided columns, skipping`);
703
- return valid;
704
- });
705
-
706
- const fullDef = createPTableDef({
707
- columns,
708
- labelColumns: fullLabelColumns,
709
- coreJoinType,
710
- partitionFilters,
711
- filters,
712
- sorting,
713
- coreColumnPredicate: ops?.coreColumnPredicate,
714
- });
715
- const fullHandle = ctx.createPTable(fullDef);
716
- if (!fullHandle) return undefined;
717
-
718
- const hiddenColumns = new Set<PObjectId>(
719
- ((): PObjectId[] => {
720
- // Inner join works as a filter - all columns must be present
721
- if (coreJoinType === "inner") return [];
722
-
723
- const hiddenColIds = tableStateNormalized.pTableParams.hiddenColIds;
724
- if (hiddenColIds) return hiddenColIds;
725
-
726
- return columns.filter((c) => isColumnOptional(c.spec)).map((c) => c.id);
727
- })(),
728
- );
729
-
730
- // Preserve linker columns
731
- columns.filter((c) => isLinkerColumn(c.spec)).forEach((c) => hiddenColumns.delete(c.id));
732
-
733
- // Preserve core columns as they change the shape of join.
734
- const coreColumnPredicate = ops?.coreColumnPredicate;
735
- if (coreColumnPredicate) {
736
- const coreColumns = columns.flatMap((c) =>
737
- coreColumnPredicate(getColumnIdAndSpec(c)) ? [c.id] : [],
738
- );
739
- coreColumns.forEach((c) => hiddenColumns.delete(c));
740
- }
741
-
742
- // Filters decrease the number of result rows, sorting changes the order of result rows
743
- [
744
- ...partitionFilters.map((f) => f.column),
745
- ...filters.map((f) => f.column),
746
- ...sorting.map((s) => s.column),
747
- ]
748
- .filter((c): c is PTableColumnIdColumn => c.type === "column")
749
- .forEach((c) => hiddenColumns.delete(c.id));
750
-
751
- const visibleColumns = columns.filter((c) => !hiddenColumns.has(c.id));
752
- const visibleLabelColumns = getMatchingLabelColumns(
753
- visibleColumns.map(getColumnIdAndSpec),
754
- allLabelColumns,
755
- );
756
-
757
- // if at least one column is not yet computed, we can't show the table
758
- if (!allPColumnsReady([...visibleColumns, ...visibleLabelColumns])) return undefined;
759
-
760
- const visibleDef = createPTableDef({
761
- columns: visibleColumns,
762
- labelColumns: visibleLabelColumns,
763
- coreJoinType,
764
- partitionFilters,
765
- filters,
766
- sorting,
767
- coreColumnPredicate,
768
- });
769
- const visibleHandle = ctx.createPTable(visibleDef);
770
- if (!visibleHandle) return undefined;
771
-
772
- return {
773
- sourceId: tableStateNormalized.pTableParams.sourceId,
774
- fullTableHandle: fullHandle,
775
- visibleTableHandle: visibleHandle,
776
- } satisfies PlDataTableModel;
777
- }
778
-
779
- /** Create sheet entries for PlDataTable */
780
- export function createPlDataTableSheet<A, U>(
781
- ctx: RenderCtxBase<A, U>,
782
- axis: AxisSpec,
783
- values: (string | number)[],
784
- ): PlDataTableSheet {
785
- const labels = ctx.resultPool.findLabels(axis);
786
- return {
787
- axis,
788
- options: values.map((v) => ({
789
- value: v,
790
- label: labels?.[v] ?? v.toString(),
791
- })),
792
- defaultValue: values[0],
793
- };
794
- }