@platforma-sdk/model 1.76.5 → 1.77.4

package/src/components/PlDataTable/state-migration.ts

@@ -7,7 +7,11 @@ import type {
   PTableRecordFilter,
   PTableSorting,
 } from "@milaboratories/pl-model-common";
-import { canonicalizeJson, parseJsonSafely } from "@milaboratories/pl-model-common";
+import {
+  canonicalizeJson,
+  getPTableColumnId,
+  parseJsonSafely,
+} from "@milaboratories/pl-model-common";
 import { distillFilterSpec } from "../../filters";
 import type { PlDataTableFilterState, PlTableFilter } from "./typesV4";
 import type {
@@ -16,7 +20,14 @@ import type {
   PlDataTableSheetState,
   PlDataTableStateV2CacheEntry,
   PlDataTableStateV2Normalized,
+  PlTableColumnIdJson,
   PTableParamsV2,
+} from "./typesV7";
+import type {
+  PlDataTableGridStateV6,
+  PlDataTableStateV2V6,
+  PlDataTableStateV2V6CacheEntry,
+  PlDataTableV6ColIdJson,
 } from "./typesV6";
 import type {
   PlDataTableGridStateV5,
@@ -106,7 +117,7 @@ export type PlDataTableStateV2 =
       version: 4;
       stateCache: {
         sourceId: string;
-        gridState: PlDataTableGridStateCore;
+        gridState: PlDataTableGridStateV6;
         sheetsState: PlDataTableSheetState[];
         filtersState: PlDataTableFilterState[];
       }[];
@@ -130,6 +141,9 @@ export type PlDataTableStateV2 =
       }[];
       pTableParams: PTableParamsV2;
     }
+  // v6 stored colIds as canonicalized full `PTableColumnSpec` (including
+  // annotations + `pl7.app/trace`). v7 strips down to `PTableColumnId`.
+  | PlDataTableStateV2V6
   // Normalized state
   | PlDataTableStateV2Normalized;
 
@@ -172,13 +186,15 @@ export function upgradePlDataTableStateV2(
   if (state.version === 5) {
     state = migrateV5toV6(state);
   }
+  // v6 -> v7: shrink colIds from full PTableColumnSpec to PTableColumnId.
+  if (state.version === 6) {
+    state = migrateV6toV7(state);
+  }
   return state;
 }
 
 /** Migrate v5 to v6: unwrap `{source, labeled}` colIds in gridState. */
-function migrateV5toV6(
-  state: Extract<PlDataTableStateV2, { version: 5 }>,
-): PlDataTableStateV2Normalized {
+function migrateV5toV6(state: Extract<PlDataTableStateV2, { version: 5 }>): PlDataTableStateV2V6 {
   // pTableParams reset: v5 stored DiscoveredPColumnId-based hiddenColIds with
   // empty-array fields (e.g. `{column, path: [], columnQualifications: [], ...}`).
   // v6 distills empty fields, so the same logical column serialises differently
@@ -204,9 +220,8 @@ function unwrapV5ColId(json: string): string {
     : json;
 }
 
-function unwrapV5GridState(gridState: PlDataTableGridStateV5): PlDataTableGridStateCore {
-  const unwrapAs = (json: PlDataTableV5ColIdJson) =>
-    unwrapV5ColId(json) as CanonicalizedJson<PTableColumnSpec>;
+function unwrapV5GridState(gridState: PlDataTableGridStateV5): PlDataTableGridStateV6 {
+  const unwrapAs = (json: PlDataTableV5ColIdJson) => unwrapV5ColId(json) as PlDataTableV6ColIdJson;
   return {
     columnOrder: gridState.columnOrder
       ? { orderedColIds: gridState.columnOrder.orderedColIds.map(unwrapAs) }
@@ -225,14 +240,57 @@ function unwrapV5GridState(gridState: PlDataTableGridStateV5): PlDataTableGridSt
   };
 }
 
+/** Migrate v6 to v7: rewrite each colId from a full PTableColumnSpec to its
+ * compact PTableColumnId (drops annotations/spec body, ~16× smaller per column). */
+function migrateV6toV7(state: PlDataTableStateV2V6): PlDataTableStateV2Normalized {
+  return {
+    version: 7,
+    stateCache: state.stateCache.map(
+      (entry): PlDataTableStateV2CacheEntry => ({
+        ...entry,
+        gridState: shrinkV6GridState(entry.gridState),
+      }),
+    ),
+    pTableParams: state.pTableParams,
+  };
+}
+
+/** Convert a v6 fat colId (canonicalized PTableColumnSpec) to a v7 compact colId
+ * (canonicalized PTableColumnId). The row-number sentinel is a string literal,
+ * not a spec — pass it through unchanged. */
+function shrinkV6ColId(json: PlDataTableV6ColIdJson): PlTableColumnIdJson {
+  const parsed: unknown = parseJsonSafely(json);
+  if (!isNil(parsed) && typeof parsed === "object" && "type" in parsed && "id" in parsed) {
+    return canonicalizeJson(getPTableColumnId(parsed as PTableColumnSpec));
+  }
+  return json as unknown as PlTableColumnIdJson;
+}
+
+function shrinkV6GridState(gridState: PlDataTableGridStateV6): PlDataTableGridStateCore {
+  return {
+    columnOrder: gridState.columnOrder
+      ? { orderedColIds: gridState.columnOrder.orderedColIds.map(shrinkV6ColId) }
+      : undefined,
+    sort: gridState.sort
+      ? {
+          sortModel: gridState.sort.sortModel.map((s) => ({
+            colId: shrinkV6ColId(s.colId),
+            sort: s.sort,
+          })),
+        }
+      : undefined,
+    columnVisibility: gridState.columnVisibility
+      ? { hiddenColIds: gridState.columnVisibility.hiddenColIds.map(shrinkV6ColId) }
+      : undefined,
+  };
+}
+
 /** Migrate v4 state to v6: convert per-column filters to tree-based format (skips v5). */
-function migrateV4toV6(
-  state: Extract<PlDataTableStateV2, { version: 4 }>,
-): PlDataTableStateV2Normalized {
+function migrateV4toV6(state: Extract<PlDataTableStateV2, { version: 4 }>): PlDataTableStateV2V6 {
   let idCounter = 0;
   const nextId = () => ++idCounter;
 
-  const migratedCache: PlDataTableStateV2CacheEntry[] = state.stateCache.map((entry) => {
+  const migratedCache: PlDataTableStateV2V6CacheEntry[] = state.stateCache.map((entry) => {
     const leaves: PlDataTableFiltersWithMeta["filters"] = [];
     for (const f of entry.filtersState) {
       if (f.filter !== null && !f.filter.disabled) {
@@ -358,7 +416,7 @@ export function createDefaultPTableParams(): PTableParamsV2 {
 
 export function createPlDataTableStateV2(): PlDataTableStateV2Normalized {
   return {
-    version: 6,
+    version: 7,
     stateCache: [],
     pTableParams: createDefaultPTableParams(),
   };

package/src/components/PlDataTable/typesV6.ts

@@ -1,152 +1,30 @@
-import type {
-  AxisId,
-  AxisSpec,
-  CanonicalizedJson,
-  ListOptionBase,
-  PTableColumnSpec,
-  PTableSorting,
-  PColumnIdAndSpec,
-  PTableHandle,
-  RootFilterSpec,
-  PTableColumnId,
-  PFrameHandle,
-} from "@milaboratories/pl-model-common";
-import type { FilterSpecLeaf } from "../../filters";
-import { Nil } from "@milaboratories/helpers";
+import type { CanonicalizedJson, PTableColumnSpec } from "@milaboratories/pl-model-common";
+import type { PlDataTableFiltersWithMeta, PlDataTableSheetState, PTableParamsV2 } from "./typesV7";
 
-export type PlTableColumnIdJson = CanonicalizedJson<PTableColumnSpec>;
+/**
+ * v6 colId scheme: bare canonicalized `PTableColumnSpec` (full spec including
+ * all annotations and `pl7.app/trace`). v7 dropped the spec body and now uses
+ * `CanonicalizedJson<PTableColumnId>` — orders of magnitude smaller.
+ */
+export type PlDataTableV6ColIdJson = CanonicalizedJson<PTableColumnSpec>;
 
-export type PlDataTableGridStateCore = {
-  /** Includes column ordering */
-  columnOrder?: {
-    /** All colIds in order */
-    orderedColIds: PlTableColumnIdJson[];
-  };
-  /** Includes current sort columns and direction */
-  sort?: {
-    /** Sorted columns and directions in order */
-    sortModel: {
-      /** Column Id to apply the sort to. */
-      colId: PlTableColumnIdJson;
-      /** Sort direction */
-      sort: "asc" | "desc";
-    }[];
-  };
-  /** Includes column visibility */
-  columnVisibility?: {
-    /** All colIds which were hidden */
-    hiddenColIds: PlTableColumnIdJson[];
-  };
+export type PlDataTableGridStateV6 = {
+  columnOrder?: { orderedColIds: PlDataTableV6ColIdJson[] };
+  sort?: { sortModel: { colId: PlDataTableV6ColIdJson; sort: "asc" | "desc" }[] };
+  columnVisibility?: { hiddenColIds: PlDataTableV6ColIdJson[] };
 };
 
-export type PlDataTableSheet = {
-  /** spec of the axis to use */
-  axis: AxisSpec;
-  /** options to show in the filter dropdown */
-  options: ListOptionBase<string | number>[];
-  /** default (selected) value */
-  defaultValue?: string | number;
-};
-
-export type PlDataTableSheetState = {
-  /** id of the axis */
-  axisId: AxisId;
-  /** selected value */
-  value: string | number;
-};
-
-/** Tree-based filter state compatible with PlAdvancedFilter's RootFilter */
-export type PlDataTableFilterMeta = {
-  id: number;
-  source?: "table-filter" | "table-search";
-  isExpanded?: boolean;
-  isSuppressed?: boolean;
-};
-export type PlDataTableFilterSpecLeaf = FilterSpecLeaf<CanonicalizedJson<PTableColumnId>>;
-export type PlDataTableFilters = RootFilterSpec<PlDataTableFilterSpecLeaf>;
-export type PlDataTableFiltersWithMeta = RootFilterSpec<
-  PlDataTableFilterSpecLeaf,
-  PlDataTableFilterMeta
->;
-
-export type PlDataTableStateV2CacheEntry = {
-  /** DataSource identifier for state management */
+export type PlDataTableStateV2V6CacheEntry = {
   sourceId: string;
-  /** Internal ag-grid state */
-  gridState: PlDataTableGridStateCore;
-  /** Sheets state */
+  gridState: PlDataTableGridStateV6;
   sheetsState: PlDataTableSheetState[];
-  /** User filters state (tree-based, compatible with PlAdvancedFilter) */
   filtersState: null | PlDataTableFiltersWithMeta;
-  /** Default filters state from model (snapshot of defaults) */
   defaultFiltersState: null | PlDataTableFiltersWithMeta;
-  /** Fast search string */
   searchString?: string;
 };
 
-export type PTableParamsV2 =
-  | {
-      sourceId: null;
-      hiddenColIds: null;
-      sorting: [];
-      filters: null;
-      defaultFilters: null;
-    }
-  | {
-      sourceId: string;
-      hiddenColIds: null | PTableColumnId[];
-      sorting: PTableSorting[];
-      filters: null | PlDataTableFilters;
-      defaultFilters: null | PlDataTableFilters;
-    };
-
-export type PlDataTableStateV2Normalized = {
-  /** Version for upgrades */
+export type PlDataTableStateV2V6 = {
   version: 6;
-  /** Internal states, LRU cache for 5 sourceId-s */
-  stateCache: PlDataTableStateV2CacheEntry[];
-  /** PTable params derived from the cache state for the current sourceId */
+  stateCache: PlDataTableStateV2V6CacheEntry[];
   pTableParams: PTableParamsV2;
 };
-
-/** PlAgDataTable model */
-export type PlDataTableModel = {
-  /** DataSource identifier for state management */
-  sourceId: null | string;
-  /** p-table including all columns, used to show the full specification of the table */
-  fullTableHandle?: PTableHandle;
-  /** p-frame handle */
-  fullPframeHandle?: PFrameHandle;
-  /** p-table including only visible columns, used to get the data */
-  visibleTableHandle?: PTableHandle;
-  /** Default filters from model options, surfaced for UI display */
-  defaultFilters?: Nil | PlDataTableFilters;
-};
-
-export type CreatePlDataTableOps = {
-  /** Filters for columns and non-partitioned axes */
-  filters?: PlDataTableFilters;
-
-  /** Sorting to columns hidden from user */
-  sorting?: PTableSorting[];
-
-  /**
-   * Selects columns for which will be inner-joined to the table.
-   *
-   * Default behaviour: all columns are considered to be core
-   */
-  coreColumnPredicate?: (spec: PColumnIdAndSpec) => boolean;
-
-  /**
-   * Determines how core columns should be joined together:
-   *   inner - so user will only see records present in all core columns
-   *   full - so user will only see records present in any of the core columns
-   *
-   * All non-core columns will be left joined to the table produced by the core
-   * columns, in other words records form the pool of non-core columns will only
-   * make their way into the final table if core table contains corresponding key.
-   *
-   * Default: 'full'
-   */
-  coreJoinType?: "inner" | "full";
-};

package/src/components/PlDataTable/typesV7.ts

@@ -0,0 +1,151 @@
+import type {
+  AxisId,
+  AxisSpec,
+  CanonicalizedJson,
+  ListOptionBase,
+  PTableSorting,
+  PColumnIdAndSpec,
+  PTableHandle,
+  RootFilterSpec,
+  PTableColumnId,
+  PFrameHandle,
+} from "@milaboratories/pl-model-common";
+import type { FilterSpecLeaf } from "../../filters";
+import { Nil } from "@milaboratories/helpers";
+
+export type PlTableColumnIdJson = CanonicalizedJson<PTableColumnId>;
+
+export type PlDataTableGridStateCore = {
+  /** Includes column ordering */
+  columnOrder?: {
+    /** All colIds in order */
+    orderedColIds: PlTableColumnIdJson[];
+  };
+  /** Includes current sort columns and direction */
+  sort?: {
+    /** Sorted columns and directions in order */
+    sortModel: {
+      /** Column Id to apply the sort to. */
+      colId: PlTableColumnIdJson;
+      /** Sort direction */
+      sort: "asc" | "desc";
+    }[];
+  };
+  /** Includes column visibility */
+  columnVisibility?: {
+    /** All colIds which were hidden */
+    hiddenColIds: PlTableColumnIdJson[];
+  };
+};
+
+export type PlDataTableSheet = {
+  /** spec of the axis to use */
+  axis: AxisSpec;
+  /** options to show in the filter dropdown */
+  options: ListOptionBase<string | number>[];
+  /** default (selected) value */
+  defaultValue?: string | number;
+};
+
+export type PlDataTableSheetState = {
+  /** id of the axis */
+  axisId: AxisId;
+  /** selected value */
+  value: string | number;
+};
+
+/** Tree-based filter state compatible with PlAdvancedFilter's RootFilter */
+export type PlDataTableFilterMeta = {
+  id: number;
+  source?: "table-filter" | "table-search";
+  isExpanded?: boolean;
+  isSuppressed?: boolean;
+};
+export type PlDataTableFilterSpecLeaf = FilterSpecLeaf<CanonicalizedJson<PTableColumnId>>;
+export type PlDataTableFilters = RootFilterSpec<PlDataTableFilterSpecLeaf>;
+export type PlDataTableFiltersWithMeta = RootFilterSpec<
+  PlDataTableFilterSpecLeaf,
+  PlDataTableFilterMeta
+>;
+
+export type PlDataTableStateV2CacheEntry = {
+  /** DataSource identifier for state management */
+  sourceId: string;
+  /** Internal ag-grid state */
+  gridState: PlDataTableGridStateCore;
+  /** Sheets state */
+  sheetsState: PlDataTableSheetState[];
+  /** User filters state (tree-based, compatible with PlAdvancedFilter) */
+  filtersState: null | PlDataTableFiltersWithMeta;
+  /** Default filters state from model (snapshot of defaults) */
+  defaultFiltersState: null | PlDataTableFiltersWithMeta;
+  /** Fast search string */
+  searchString?: string;
+};
+
+export type PTableParamsV2 =
+  | {
+      sourceId: null;
+      hiddenColIds: null;
+      sorting: [];
+      filters: null;
+      defaultFilters: null;
+    }
+  | {
+      sourceId: string;
+      hiddenColIds: null | PTableColumnId[];
+      sorting: PTableSorting[];
+      filters: null | PlDataTableFilters;
+      defaultFilters: null | PlDataTableFilters;
+    };
+
+export type PlDataTableStateV2Normalized = {
+  /** Version for upgrades */
+  version: 7;
+  /** Internal states, LRU cache for 5 sourceId-s */
+  stateCache: PlDataTableStateV2CacheEntry[];
+  /** PTable params derived from the cache state for the current sourceId */
+  pTableParams: PTableParamsV2;
+};
+
+/** PlAgDataTable model */
+export type PlDataTableModel = {
+  /** DataSource identifier for state management */
+  sourceId: null | string;
+  /** p-table including all columns, used to show the full specification of the table */
+  fullTableHandle?: PTableHandle;
+  /** p-frame handle */
+  fullPframeHandle?: PFrameHandle;
+  /** p-table including only visible columns, used to get the data */
+  visibleTableHandle?: PTableHandle;
+  /** Default filters from model options, surfaced for UI display */
+  defaultFilters?: Nil | PlDataTableFilters;
+};
+
+export type CreatePlDataTableOps = {
+  /** Filters for columns and non-partitioned axes */
+  filters?: PlDataTableFilters;
+
+  /** Sorting to columns hidden from user */
+  sorting?: PTableSorting[];
+
+  /**
+   * Selects columns for which will be inner-joined to the table.
+   *
+   * Default behaviour: all columns are considered to be core
+   */
+  coreColumnPredicate?: (spec: PColumnIdAndSpec) => boolean;
+
+  /**
+   * Determines how core columns should be joined together:
+   *   inner - so user will only see records present in all core columns
+   *   full - so user will only see records present in any of the core columns
+   *
+   * All non-core columns will be left joined to the table produced by the core
+   * columns, in other words records form the pool of non-core columns will only
+   * make their way into the final table if core table contains corresponding key.
+   *
+   * Default: 'full'
+   */
+  coreJoinType?: "inner" | "full";
+};