@platforma-sdk/model 1.30.26 → 1.30.37

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const PlatformaSDKVersion = "1.30.26";
+export declare const PlatformaSDKVersion = "1.30.37";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platforma-sdk/model",
-  "version": "1.30.26",
+  "version": "1.30.37",
   "description": "Platforma.bio SDK / Block Model",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",

package/src/components/PlDataTable.ts

@@ -16,16 +16,30 @@ import type {
   PTableRecordFilter,
   PTableRecordSingleValueFilterV2,
   PTableSorting,
+  PTableValue,
 } from '@milaboratories/pl-model-common';
-import { canonicalizeJson, getAxisId, getColumnIdAndSpec, matchAxisId } from '@milaboratories/pl-model-common';
-import type { AxisLabelProvider, ColumnProvider, RenderCtx } from '../render';
-import { PColumnCollection, TreeNodeAccessor } from '../render';
+import {
+  canonicalizeJson,
+  getAxisId,
+  getColumnIdAndSpec,
+  matchAxisId,
+  parseJson,
+} from '@milaboratories/pl-model-common';
+import type {
+  AxisLabelProvider,
+  ColumnProvider,
+  RenderCtx,
+} from '../render';
+import {
+  PColumnCollection,
+  TreeNodeAccessor,
+} from '../render';
 
 /** Canonicalized PTableColumnSpec JSON string */
 export type PTableColumnSpecJson = CanonicalizedJson<PTableColumnSpec>;
 
 /** Encode `PTableColumnId` as canonicalized JSON string */
-export function stringifyPTableColumnId(spec: PTableColumnSpec): PTableColumnSpecJson {
+export function stringifyPTableColumnSpec(spec: PTableColumnSpec): PTableColumnSpecJson {
   const type = spec.type;
   switch (type) {
     case 'axis':
@@ -38,11 +52,6 @@ export function stringifyPTableColumnId(spec: PTableColumnSpec): PTableColumnSpe
   }
 }
 
-/** Parse `PTableColumnId` from JSON string */
-export function parsePTableColumnId(str: PTableColumnSpecJson): PTableColumnSpec {
-  return JSON.parse(str) as PTableColumnSpec;
-}
-
 /** Data table state */
 export type PlDataTableGridState = {
   // TODO request stable key from the driver
@@ -568,6 +577,17 @@ export type PlDataTableModel = {
   tableHandle: PTableHandle;
 };
 
+/**
+ * @deprecated Used only in PlAgDataTable v1 that is no longer maintained.
+ * Please migrate to v2.
+ */
+export type PTableRowKey = PTableValue[];
+
+/** Check if column should be omitted from the table */
+export function isColumnHidden(spec: { annotations?: Record<string, string> }): boolean {
+  return spec.annotations?.['pl7.app/table/visibility'] === 'hidden';
+}
+
 /** Check if column is hidden by default */
 export function isColumnOptional(spec: { annotations?: Record<string, string> }): boolean {
   return spec.annotations?.['pl7.app/table/visibility'] === 'optional';
@@ -583,7 +603,7 @@ export function isColumnOptional(spec: { annotations?: Record<string, string> })
  */
 export function createPlDataTableV2<A, U>(
   ctx: RenderCtx<A, U>,
-  columns: PColumn<TreeNodeAccessor | PColumnValues | DataInfo<TreeNodeAccessor>>[],
+  inputColumns: PColumn<TreeNodeAccessor | PColumnValues | DataInfo<TreeNodeAccessor>>[],
   mainColumnPredicate: (spec: PColumnSpec) => boolean,
   tableState: PlDataTableState | undefined,
   ops?: CreatePlDataTableOps,
@@ -592,6 +612,7 @@ export function createPlDataTableV2<A, U>(
   const filters: PTableRecordSingleValueFilterV2[]
     = [...(ops?.filters ?? []), ...(tableState?.pTableParams?.filters ?? [])];
   const sorting: PTableSorting[] = tableState?.pTableParams?.sorting ?? [];
+  const columns = inputColumns.filter((c) => !isColumnHidden(c.spec));
 
   const mainColumn = columns.find((c) => mainColumnPredicate(c.spec));
   if (!mainColumn) return undefined;
@@ -604,7 +625,7 @@ export function createPlDataTableV2<A, U>(
     if (coreJoinType === 'inner') return [];
 
     const hiddenColIds = tableState?.gridState.columnVisibility?.hiddenColIds
-      ?.map(parsePTableColumnId)
+      ?.map(parseJson)
       .filter((c) => c.type === 'column')
       .map((c) => c.id);
     if (hiddenColIds) return hiddenColIds;

package/src/components/PlMultiSequenceAlignment.ts

@@ -0,0 +1,71 @@
+import type {
+  CanonicalizedJson,
+  PColumn,
+  PColumnIdAndSpec,
+  PColumnKey,
+  PColumnValues,
+  PColumnValuesEntry,
+  PObjectId,
+  PTableColumnId,
+} from '@milaboratories/pl-model-common';
+import {
+  canonicalizeJson,
+  isPTableAbsent,
+} from '@milaboratories/pl-model-common';
+import type { PlSelectionModel } from './PlSelectionModel';
+
+/** Canonicalized PTableColumnId JSON string */
+export type PTableColumnIdJson = CanonicalizedJson<PTableColumnId>;
+
+/** Encode `PTableColumnId` as canonicalized JSON string */
+export function stringifyPTableColumnId(
+  id: PTableColumnId,
+): PTableColumnIdJson {
+  const type = id.type;
+  switch (type) {
+    case 'axis':
+      return canonicalizeJson(id);
+    case 'column':
+      return canonicalizeJson(id);
+    default:
+      // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+      throw Error(`unsupported column type: ${type satisfies never}`);
+  }
+}
+
+export type PColumnPredicate = (column: PColumnIdAndSpec) => boolean;
+
+export type PlMultiSequenceAlignmentModel = {
+  sequenceColumnIds?: PObjectId[];
+  labelColumnIds?: PTableColumnIdJson[];
+};
+
+export function createRowSelectionColumn(
+  columnId: PObjectId,
+  rowSelectionModel: PlSelectionModel | undefined,
+  label?: string,
+  domain?: Record<string, string>,
+): PColumn<PColumnValues> | undefined {
+  if (!rowSelectionModel || rowSelectionModel.axesSpec.length === 0) {
+    return undefined;
+  }
+
+  return {
+    id: columnId,
+    spec: {
+      kind: 'PColumn',
+      valueType: 'Int',
+      name: 'pl7.app/table/row-selection',
+      axesSpec: rowSelectionModel.axesSpec,
+      ...(domain && { domain }),
+      annotations: {
+        'pl7.app/label': label ?? 'Selected rows',
+        'pl7.app/discreteValues': '[1]',
+      },
+    },
+    data: rowSelectionModel
+      .selectedKeys
+      .filter((r): r is PColumnKey => !r.some((v) => isPTableAbsent(v)))
+      .map((r) => ({ key: r, val: 1 } satisfies PColumnValuesEntry)),
+  } satisfies PColumn<PColumnValues>;
+}

package/src/components/PlSelectionModel.ts

@@ -0,0 +1,27 @@
+import type { AxesSpec, PTableAbsent, PTableValue } from '@milaboratories/pl-model-common';
+import { PTableNA } from '@milaboratories/pl-model-common';
+
+/** Key is a set of all axes values, which means it is unique across rows */
+export type PTableKey = AxisValue[];
+
+/** Readable axis value */
+export type AxisValue = string | number | PTableAbsent;
+
+/**
+ * Information on selected rows.
+ * for selectedKeys = [[axis1Value, axis2Value, axis3Value], ...]
+ * axesSpec would be [axis1Spec, axis2Spec, axis3Spec]
+ */
+export type PlSelectionModel = {
+  /** Specs for {@link AxisValue}'s in {@link PTableKey} */
+  axesSpec: AxesSpec;
+  /** Row keys (arrays of axes values) of selected rows */
+  selectedKeys: PTableKey[];
+};
+
+export function mapPTableValueToAxisKey(value: PTableValue): AxisValue {
+  if (value === PTableNA) {
+    throw new Error('Axis value can never be N/A');
+  }
+  return value;
+}

package/src/components/index.ts

@@ -1,2 +1,4 @@
-export * from './PlDataTable';
 export * from './PFrameForGraphs';
+export * from './PlDataTable';
+export * from './PlMultiSequenceAlignment';
+export * from './PlSelectionModel';