@milaboratories/pl-model-middle-layer 1.2.16

package/src/pframe/internal_api/table.ts

@@ -0,0 +1,49 @@
+import {
+  PTableColumnId,
+  PTableColumnSpec,
+  PTableShape,
+  PTableSorting,
+  PTableVector,
+  TableRange
+} from '@milaboratories/pl-model-common';
+
+/**
+ * Table view returned as a result of create table operation.
+ *
+ * PTable can be thought as having a composite primary key, consisting of axes,
+ * and a set of data columns derived from PColumn values.
+ * */
+export interface PTable {
+  /** Unified table shape */
+  getShape(): PTableShape;
+
+  /**
+   * Returns ordered array of table axes specs (primary key "columns" in SQL
+   * terms) and data column specs (regular "columns" in SQL terms).
+   *
+   * Data for a specific table column can be retrieved using unified indexing
+   * corresponding to elements in this array.
+   *
+   * Axes are always listed first.
+   * */
+  getSpec(): PTableColumnSpec[];
+
+  /** Transforms unified column identifiers into unified indices of columns. */
+  getColumnIndices(columnIds: PTableColumnId[]): number[];
+
+  /**
+   * Retrieve the data from the table. To retrieve only data required, it can be
+   * sliced both horizontally ({@link columnIndices}) and vertically
+   * ({@link range}).
+   *
+   * @param columnIndices unified indices of columns to be retrieved
+   * @param range optionally limit the range of records to retrieve
+   * */
+  getData(columnIndices: number[], range?: TableRange): Promise<PTableVector[]>;
+
+  /** Sorts the table and returns new PTable instance. */
+  sort(request: PTableSorting[]): Promise<PTable>;
+
+  /** Deallocates all underlying resources */
+  dispose(): void;
+}

package/src/project.ts

@@ -0,0 +1,4 @@
+export interface ProjectMeta {
+  /** Project name */
+  readonly label: string;
+}

package/src/project_list.ts

@@ -0,0 +1,19 @@
+import { ProjectMeta } from './project';
+
+/** Represents single entry in the list of projects owned by current user */
+export interface ProjectListEntry {
+  /** Project resource ID. */
+  rid: bigint;
+  /** Internal (user-specific) project id */
+  id: string;
+  /** Creation timestamp. */
+  created: Date;
+  /** Last modification timestamp. */
+  lastModified: Date;
+  /** True if project is opened */
+  opened: boolean;
+  /** Project meta, namely label */
+  meta: ProjectMeta;
+}
+
+// export type ProjectList = ProjectListEntry[];

package/src/project_overview.ts

@@ -0,0 +1,126 @@
+import { ProjectMeta } from './project';
+import { BlockPackSpec } from './block_pack';
+import { BlockRenderingMode, BlockSection, NavigationState } from '@milaboratories/pl-model-common';
+import { AuthorMarker } from './author_marker';
+
+/** Generalized block status, to be used in block item "styling". */
+export type BlockCalculationStatus = 'NotCalculated' | 'Running' | 'Done' | 'Limbo';
+
+/** Overview of the whole project state, required to render a left panel. */
+export type ProjectOverview = {
+  /** Metadata, like project label associated with the project */
+  meta: ProjectMeta;
+
+  /** Creation timestamp. */
+  created: Date;
+
+  /** Last modification timestamp. */
+  lastModified: Date;
+
+  /**
+   * Marker of the party last doing modification of the project structure
+   *   - whole project renamed
+   *   - blocks reordering
+   *   - block renaming
+   *   - block-pack update
+   * */
+  authorMarker?: AuthorMarker;
+
+  /** Overview information for each block */
+  blocks: BlockStateOverview[];
+};
+
+/** Overview of the block state, required for visualization in the left panel */
+export type BlockStateOverview = {
+  /** Block id */
+  id: string;
+
+  /** Blocks label visible to the user */
+  label: string;
+
+  /** Block rendering mode */
+  renderingMode: BlockRenderingMode;
+
+  /**
+   * True if block have missing references, e.g. referenced block was deleted
+   * or moved downstream.
+   * */
+  missingReference: boolean;
+
+  /**
+   * Means that current heavy results (or results being calculated at the
+   * moment) are not in sync with current arguments. This takes into account
+   * stale state of all upstream blocks as well. Initial state also considered
+   * stale.
+   * */
+  stale: boolean;
+
+  /**
+   * True if any of the outputs have errors. Errors may appear even before
+   * calculations are finished.
+   * */
+  outputErrors: boolean;
+
+  /**
+   * If outputs have errors, this field will contain the error message extracted
+   * from the outputs map.
+   * */
+  outputsError?: string;
+
+  /**
+   * If exports context have errors, this field will contain the error message
+   * extracted from the exports context resource.
+   * */
+  exportsError?: string;
+
+  /** Generalized block calculation status */
+  calculationStatus: BlockCalculationStatus;
+
+  /**
+   * All upstream blocks of this block. In other words all dependencies of this
+   * block, including transitive dependencies.
+   * */
+  upstreams: string[];
+
+  /**
+   * All downstream blocks of this block. In other words all blocks that depends
+   * on outputs of this block, accounting for transitive dependencies.
+   * */
+  downstreams: string[];
+
+  /**
+   * Block sections. May be unavailable, if block-pack for this block is not
+   * yet materialized.
+   * */
+  sections: BlockSection[] | undefined;
+
+  /**
+   * True if inputs of current block are suitable for block execution.
+   * May be unavailable, if block-pack for this block is not yet materialized.
+   * */
+  inputsValid: boolean | undefined;
+
+  /**
+   * True if current block can be executed. This takes into account can run of
+   * all upstream blocks as well.
+   * */
+  canRun: boolean;
+
+  /**
+   * SDK version the block was compiled with.
+   * Udefined when block-pack for this block is not yet materialized.
+   * */
+  sdkVersion: string | undefined;
+
+  /** Information on where the block pack for this block came from */
+  currentBlockPack: BlockPackSpec | undefined;
+
+  /**
+   * If block pack update is available this field will contain latest specs to
+   * perform the update
+   * */
+  updatedBlockPack: BlockPackSpec | undefined;
+
+  /** Current navigation state of the block */
+  navigationState: NavigationState;
+};