@milaboratories/pl-model-middle-layer 1.2.16 → 1.2.17

package/dist/pframe/internal_api/api_factory.d.ts

@@ -0,0 +1,52 @@
+import { PColumnSpec, PObjectId } from '@milaboratories/pl-model-common';
+/** Abstract identifier of a data blob that can be requested from the storage backend */
+export type PFrameBlobId = string;
+export type JsonDataValue = string | number | null;
+export type JsonDataInfo = {
+    type: 'Json';
+    keyLength: number;
+    data: Record<string, JsonDataValue>;
+};
+export type JsonPartitionedDataInfo<Blob = PFrameBlobId> = {
+    type: 'JsonPartitioned';
+    partitionKeyLength: number;
+    parts: Record<string, Blob>;
+};
+export type BinaryChunkInfo<Blob = PFrameBlobId> = {
+    index: Blob;
+    values: Blob;
+};
+export type BinaryPartitionedDataInfo<Blob = PFrameBlobId> = {
+    type: 'BinaryPartitioned';
+    partitionKeyLength: number;
+    parts: Record<string, BinaryChunkInfo<Blob>>;
+};
+export type DataInfo<Blob = PFrameBlobId> = JsonDataInfo | JsonPartitionedDataInfo<Blob> | BinaryPartitionedDataInfo<Blob>;
+/** Path of the file containing requested data (blob). This path is returned by
+ * {@link BlobPathResolver} as soon as blob materialized in the file system. */
+export type FilePath = string;
+/** Data source allows PFrame to retrieve the data blobs for columns with assigned data info. */
+export type PFrameDataSource = {
+    /**
+     * PFrame may notify storage backend about its plans to use particular blobs in the future.
+     * Storage backend will do its best to preload specified blob so the subsequent
+     * {@link resolveBlob} will quickly return preloaded file path.
+     */
+    preloadBlob(blobIds: PFrameBlobId[]): Promise<void>;
+    /** Allows to read actual data given the blob id from {@link DataInfo}. */
+    resolveBlob(blobId: PFrameBlobId): Promise<FilePath>;
+};
+/** API exposed by PFrames library allowing to create and provide data for
+ * PFrame objects */
+export interface PFrameFactoryAPI {
+    /** Associates data source with this PFrame */
+    setDataSource(dataSource: PFrameDataSource): void;
+    /** Adds PColumn without spec */
+    addColumnSpec(columnId: PObjectId, columnSpec: PColumnSpec): void;
+    /** Associates data info with cpecific column */
+    setColumnData(columnId: PObjectId, dataInfo: DataInfo): void;
+    /** Releases all the data previously added to PFrame using methods above,
+     * any interactions with disposed PFrame will result in exception */
+    dispose(): void;
+}
+//# sourceMappingURL=api_factory.d.ts.map

package/dist/pframe/internal_api/api_factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api_factory.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/api_factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAEzE,wFAAwF;AACxF,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC;AAElC,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;AAEnD,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,uBAAuB,CAAC,IAAI,GAAG,YAAY,IAAI;IACzD,IAAI,EAAE,iBAAiB,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,CAAC,IAAI,GAAG,YAAY,IAAI;IACjD,KAAK,EAAE,IAAI,CAAC;IACZ,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,yBAAyB,CAAC,IAAI,GAAG,YAAY,IAAI;IAC3D,IAAI,EAAE,mBAAmB,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC;CAC9C,CAAC;AAEF,MAAM,MAAM,QAAQ,CAAC,IAAI,GAAG,YAAY,IACpC,YAAY,GACZ,uBAAuB,CAAC,IAAI,CAAC,GAC7B,yBAAyB,CAAC,IAAI,CAAC,CAAC;AAEpC;+EAC+E;AAC/E,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC;AAE9B,gGAAgG;AAChG,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;;;OAIG;IACH,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD,0EAA0E;IAC1E,WAAW,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CACtD,CAAC;AAEF;oBACoB;AACpB,MAAM,WAAW,gBAAgB;IAC/B,8CAA8C;IAC9C,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAElD,gCAAgC;IAChC,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,WAAW,GAAG,IAAI,CAAC;IAElE,gDAAgD;IAChD,aAAa,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAE7D;wEACoE;IACpE,OAAO,IAAI,IAAI,CAAC;CACjB"}

package/dist/pframe/internal_api/api_read.d.ts

@@ -0,0 +1,28 @@
+import { FindColumnsRequest, FindColumnsResponse } from './find_columns';
+import { DeleteColumnFromColumnsRequest, DeleteColumnFromColumnsResponse } from './delete_column';
+import { PColumnInfo, PColumnSpec, PObjectId, UniqueValuesRequest, UniqueValuesResponse } from '@milaboratories/pl-model-common';
+import { CreateTableRequest } from './create_table';
+import { PTable } from './table';
+/** Read interface exposed by PFrames library */
+export interface PFrameReadAPI {
+    /**
+     * Finds columns given filtering criteria on column name, annotations etc.
+     * and a set of qualified axes specs to find only columns with compatible
+     * axes spec.
+     *
+     * Only column specs are used, this method will work even for columns
+     * with no assigned data.
+     * */
+    findColumns(request: FindColumnsRequest): Promise<FindColumnsResponse>;
+    /** To be reviewed in the future */
+    deleteColumn(request: DeleteColumnFromColumnsRequest): Promise<DeleteColumnFromColumnsResponse>;
+    /** Retrieve single column spec */
+    getColumnSpec(columnId: PObjectId): Promise<PColumnSpec>;
+    /** Retrieve information about all columns currently added to the PFrame */
+    listColumns(): Promise<PColumnInfo[]>;
+    /** Calculates data for the table and returns an object to access it */
+    createTable(request: CreateTableRequest): Promise<PTable>;
+    /** Calculate set of unique values for a specific axis for the filtered set of records */
+    getUniqueValues(request: UniqueValuesRequest): Promise<UniqueValuesResponse>;
+}
+//# sourceMappingURL=api_read.d.ts.map

package/dist/pframe/internal_api/api_read.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api_read.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/api_read.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACzE,OAAO,EAAE,8BAA8B,EAAE,+BAA+B,EAAE,MAAM,iBAAiB,CAAC;AAClG,OAAO,EACL,WAAW,EACX,WAAW,EACX,SAAS,EACT,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEjC,gDAAgD;AAChD,MAAM,WAAW,aAAa;IAC5B;;;;;;;SAOK;IACL,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEvE,mCAAmC;IACnC,YAAY,CAAC,OAAO,EAAE,8BAA8B,GAAG,OAAO,CAAC,+BAA+B,CAAC,CAAC;IAEhG,kCAAkC;IAClC,aAAa,CAAC,QAAQ,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEzD,2EAA2E;IAC3E,WAAW,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC;IAEtC,uEAAuE;IACvE,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1D,yFAAyF;IACzF,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAC9E"}

package/dist/pframe/internal_api/common.d.ts

@@ -0,0 +1,19 @@
+import { AxisId, AxisSpec, ValueType } from '@milaboratories/pl-model-common';
+export interface SingleAxisSelector {
+    name: string;
+    type?: ValueType;
+    domain?: Record<string, string>;
+}
+export interface AxisQualification {
+    axis: SingleAxisSelector;
+    additionalDomains: Record<string, string>;
+}
+export interface AxisQualificationWithAxisId {
+    axis: AxisId;
+    additionalDomains: Record<string, string>;
+}
+export interface ColumnAxesWithQualifications {
+    axesSpec: AxisSpec[];
+    qualifications: AxisQualification[];
+}
+//# sourceMappingURL=common.d.ts.map

package/dist/pframe/internal_api/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,iCAAiC,CAAC;AAE9E,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,kBAAkB,CAAC;IACzB,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,QAAQ,EAAE,CAAC;IACrB,cAAc,EAAE,iBAAiB,EAAE,CAAC;CACrC"}

package/dist/pframe/internal_api/create_table.d.ts

@@ -0,0 +1,26 @@
+import { AxisQualificationWithAxisId } from './common';
+import { PObjectId, PTableRecordFilter } from '@milaboratories/pl-model-common';
+export interface ColumnJoinEntry {
+    type: 'column';
+    columnId: PObjectId;
+    qualifications: AxisQualificationWithAxisId[];
+}
+export interface InnerJoin {
+    type: 'inner';
+    entries: JoinEntry[];
+}
+export interface FullJoin {
+    type: 'full';
+    entries: JoinEntry[];
+}
+export interface OuterJoin {
+    type: 'outer';
+    primary: JoinEntry;
+    secondary: JoinEntry[];
+}
+export type JoinEntry = ColumnJoinEntry | InnerJoin | FullJoin | OuterJoin;
+export interface CreateTableRequest {
+    src: JoinEntry;
+    filters: PTableRecordFilter[];
+}
+//# sourceMappingURL=create_table.d.ts.map

package/dist/pframe/internal_api/create_table.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"create_table.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/create_table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,2BAA2B,EAAE,MAAM,UAAU,CAAC;AACvD,OAAO,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAEhF,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,SAAS,CAAC;IACpB,cAAc,EAAE,2BAA2B,EAAE,CAAC;CAC/C;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,SAAS,EAAE,CAAC;CACtB;AAED,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,SAAS,CAAC;IACnB,SAAS,EAAE,SAAS,EAAE,CAAC;CACxB;AAED,MAAM,MAAM,SAAS,GAAG,eAAe,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE3E,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,SAAS,CAAC;IACf,OAAO,EAAE,kBAAkB,EAAE,CAAC;CAC/B"}

package/dist/pframe/internal_api/delete_column.d.ts

@@ -0,0 +1,10 @@
+import { ColumnAxesWithQualifications } from './common';
+export interface DeleteColumnFromColumnsRequest {
+    columns: ColumnAxesWithQualifications[];
+    /** Zero based index of the column to delete */
+    delete: number;
+}
+export interface DeleteColumnFromColumnsResponse {
+    columns: ColumnAxesWithQualifications[];
+}
+//# sourceMappingURL=delete_column.d.ts.map

package/dist/pframe/internal_api/delete_column.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"delete_column.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/delete_column.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAExD,MAAM,WAAW,8BAA8B;IAC7C,OAAO,EAAE,4BAA4B,EAAE,CAAC;IAExC,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,+BAA+B;IAC9C,OAAO,EAAE,4BAA4B,EAAE,CAAC;CACzC"}

package/dist/pframe/internal_api/find_columns.d.ts

@@ -0,0 +1,23 @@
+import { ColumnFilter, PColumnIdAndSpec } from '@milaboratories/pl-model-common';
+import { AxisQualification, ColumnAxesWithQualifications } from './common';
+export interface FindColumnsRequest {
+    columnFilter: ColumnFilter;
+    compatibleWith: ColumnAxesWithQualifications[];
+    strictlyCompatible: boolean;
+}
+export interface FindColumnResponseQualifications {
+    forQueries: AxisQualification[][];
+    forHit: AxisQualification[];
+}
+export interface FindColumnsMappingVariant {
+    qualifications: FindColumnResponseQualifications;
+    distinctiveQualifications: FindColumnResponseQualifications;
+}
+export interface FindColumnsResponseHit {
+    hit: PColumnIdAndSpec;
+    mappingVariants: FindColumnsMappingVariant[];
+}
+export interface FindColumnsResponse {
+    hits: FindColumnsResponseHit[];
+}
+//# sourceMappingURL=find_columns.d.ts.map

package/dist/pframe/internal_api/find_columns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find_columns.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/find_columns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACjF,OAAO,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAE3E,MAAM,WAAW,kBAAkB;IACjC,YAAY,EAAE,YAAY,CAAC;IAC3B,cAAc,EAAE,4BAA4B,EAAE,CAAC;IAC/C,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED,MAAM,WAAW,gCAAgC;IAC/C,UAAU,EAAE,iBAAiB,EAAE,EAAE,CAAC;IAClC,MAAM,EAAE,iBAAiB,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,yBAAyB;IACxC,cAAc,EAAE,gCAAgC,CAAC;IACjD,yBAAyB,EAAE,gCAAgC,CAAC;CAC7D;AAED,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,gBAAgB,CAAC;IACtB,eAAe,EAAE,yBAAyB,EAAE,CAAC;CAC9C;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,sBAAsB,EAAE,CAAC;CAChC"}

package/dist/pframe/internal_api/index.d.ts

@@ -0,0 +1,9 @@
+export * from './api_read';
+export * from './api_factory';
+export * from './common';
+export * from './create_table';
+export * from './delete_column';
+export * from './find_columns';
+export * from './table';
+export * from './pframe';
+//# sourceMappingURL=index.d.ts.map

package/dist/pframe/internal_api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,SAAS,CAAC;AAExB,cAAc,UAAU,CAAC"}

package/dist/pframe/internal_api/pframe.d.ts

@@ -0,0 +1,4 @@
+import { PFrameReadAPI, PFrameFactoryAPI } from './index';
+export interface PFrame extends PFrameFactoryAPI, PFrameReadAPI {
+}
+//# sourceMappingURL=pframe.d.ts.map

package/dist/pframe/internal_api/pframe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pframe.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/pframe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE1D,MAAM,WAAW,MAAO,SAAQ,gBAAgB,EAAE,aAAa;CAC9D"}

package/dist/pframe/internal_api/table.d.ts

@@ -0,0 +1,37 @@
+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;
+}
+//# sourceMappingURL=table.d.ts.map

package/dist/pframe/internal_api/table.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/table.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,WAAW,EACX,aAAa,EACb,YAAY,EACZ,UAAU,EACX,MAAM,iCAAiC,CAAC;AAEzC;;;;;KAKK;AACL,MAAM,WAAW,MAAM;IACrB,0BAA0B;IAC1B,QAAQ,IAAI,WAAW,CAAC;IAExB;;;;;;;;SAQK;IACL,OAAO,IAAI,gBAAgB,EAAE,CAAC;IAE9B,6EAA6E;IAC7E,gBAAgB,CAAC,SAAS,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC;IAExD;;;;;;;SAOK;IACL,OAAO,CAAC,aAAa,EAAE,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAE9E,uDAAuD;IACvD,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEhD,2CAA2C;IAC3C,OAAO,IAAI,IAAI,CAAC;CACjB"}

package/dist/project.d.ts

@@ -0,0 +1,5 @@
+export interface ProjectMeta {
+    /** Project name */
+    readonly label: string;
+}
+//# sourceMappingURL=project.d.ts.map

package/dist/project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../src/project.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB"}

package/dist/project_list.d.ts

@@ -0,0 +1,17 @@
+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;
+}
+//# sourceMappingURL=project_list.d.ts.map

package/dist/project_list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project_list.d.ts","sourceRoot":"","sources":["../src/project_list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAExC,4EAA4E;AAC5E,MAAM,WAAW,gBAAgB;IAC/B,2BAA2B;IAC3B,GAAG,EAAE,MAAM,CAAC;IACZ,0CAA0C;IAC1C,EAAE,EAAE,MAAM,CAAC;IACX,0BAA0B;IAC1B,OAAO,EAAE,IAAI,CAAC;IACd,mCAAmC;IACnC,YAAY,EAAE,IAAI,CAAC;IACnB,gCAAgC;IAChC,MAAM,EAAE,OAAO,CAAC;IAChB,iCAAiC;IACjC,IAAI,EAAE,WAAW,CAAC;CACnB"}

package/dist/project_overview.d.ts

@@ -0,0 +1,103 @@
+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;
+};
+//# sourceMappingURL=project_overview.d.ts.map

package/dist/project_overview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project_overview.d.ts","sourceRoot":"","sources":["../src/project_overview.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACpG,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,oEAAoE;AACpE,MAAM,MAAM,sBAAsB,GAAG,eAAe,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,CAAC;AAEpF,4EAA4E;AAC5E,MAAM,MAAM,eAAe,GAAG;IAC5B,+DAA+D;IAC/D,IAAI,EAAE,WAAW,CAAC;IAElB,0BAA0B;IAC1B,OAAO,EAAE,IAAI,CAAC;IAEd,mCAAmC;IACnC,YAAY,EAAE,IAAI,CAAC;IAEnB;;;;;;SAMK;IACL,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,0CAA0C;IAC1C,MAAM,EAAE,kBAAkB,EAAE,CAAC;CAC9B,CAAC;AAEF,gFAAgF;AAChF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,eAAe;IACf,EAAE,EAAE,MAAM,CAAC;IAEX,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;IAEd,2BAA2B;IAC3B,aAAa,EAAE,kBAAkB,CAAC;IAElC;;;SAGK;IACL,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;;;SAKK;IACL,KAAK,EAAE,OAAO,CAAC;IAEf;;;SAGK;IACL,YAAY,EAAE,OAAO,CAAC;IAEtB;;;SAGK;IACL,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;SAGK;IACL,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,2CAA2C;IAC3C,iBAAiB,EAAE,sBAAsB,CAAC;IAE1C;;;SAGK;IACL,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;;SAGK;IACL,WAAW,EAAE,MAAM,EAAE,CAAC;IAEtB;;;SAGK;IACL,QAAQ,EAAE,YAAY,EAAE,GAAG,SAAS,CAAC;IAErC;;;SAGK;IACL,WAAW,EAAE,OAAO,GAAG,SAAS,CAAC;IAEjC;;;SAGK;IACL,MAAM,EAAE,OAAO,CAAC;IAEhB;;;SAGK;IACL,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAE/B,mEAAmE;IACnE,gBAAgB,EAAE,aAAa,GAAG,SAAS,CAAC;IAE5C;;;SAGK;IACL,gBAAgB,EAAE,aAAa,GAAG,SAAS,CAAC;IAE5C,4CAA4C;IAC5C,eAAe,EAAE,eAAe,CAAC;CAClC,CAAC"}

package/package.json

@@ -1,13 +1,12 @@
 {
   "name": "@milaboratories/pl-model-middle-layer",
-  "version": "1.2.16",
+  "version": "1.2.17",
   "description": "Common model between middle layer and non-block UI code",
-  "type": "module",
   "exports": {
     ".": {
-      "types": "./src/index.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
     }
   },
   "files": [
@@ -17,14 +16,15 @@
   "dependencies": {
     "zod": "^3.23.8",
     "utility-types": "^3.11.0",
-    "@milaboratories/pl-model-common": "^1.3.9"
+    "@milaboratories/pl-model-common": "^1.3.10"
   },
   "devDependencies": {
-    "tsup": "~8.2.4",
-    "typescript": "^5.6.2",
-    "@milaboratories/platforma-build-configs": "1.0.0"
+    "typescript": "~5.6.2",
+    "vite": "^5.4.7",
+    "@milaboratories/platforma-build-configs": "1.0.1"
   },
   "scripts": {
-    "build": "tsup"
+    "type-check": "tsc --noEmit --composite false",
+    "build": "vite build"
   }
 }

package/src/block_meta/index.ts

@@ -1,30 +1,24 @@
-import { ZodTypeAny, z } from 'zod';
-import {
-  BlockComponentsDescriptionRaw,
-  BlockComponentsManifest
-} from './block_components';
+import { ZodTypeAny, string, z } from 'zod';
+import { BlockComponentsDescriptionRaw, BlockComponentsManifest } from './block_components';
 import { BlockPackId } from './block_pack_id';
-import {
-  BlockPackMetaDescriptionRaw,
-  BlockPackMetaManifest
-} from './meta';
+import { BlockPackMetaDescriptionRaw, BlockPackMetaManifest } from './meta';
 
-export * from './block_components'
-export * from './block_pack_id'
-export * from './common'
-export * from './content_types'
-export * from './meta'
-export * from './semver'
+export * from './block_components';
+export * from './block_pack_id';
+export * from './common';
+export * from './content_types';
+export * from './meta';
+export * from './semver';
 
 export const BlockPackDescriptionFromPackageJsonRaw = z.object({
   components: BlockComponentsDescriptionRaw,
   meta: BlockPackMetaDescriptionRaw
 });
 
-export function CreateBlockPackDescriptionSchema<Components extends ZodTypeAny, Meta extends ZodTypeAny>(
-  components: Components,
-  meta: Meta
-) {
+export function CreateBlockPackDescriptionSchema<
+  Components extends ZodTypeAny,
+  Meta extends ZodTypeAny
+>(components: Components, meta: Meta) {
   return z.object({
     id: BlockPackId,
     components,
@@ -44,8 +38,20 @@ export const BlockPackDescriptionRaw = CreateBlockPackDescriptionSchema(
 );
 export type BlockPackDescriptionRaw = z.infer<typeof BlockPackDescriptionRaw>;
 
-export const BlockPackManifest = BlockPackDescriptionManifest.extend({
+export const ManifestFileInfo = z.object({
+  name: z.string(),
+  size: z.number().int(),
+  sha256: z
+    .string()
+    .regex(/[0-9a-fA-F]/)
+    .toUpperCase()
+    .length(64) // 256 / 4 (bits per hex register)
+});
+export type ManifestFileInfo = z.infer<typeof ManifestFileInfo>;
+
+export const BlockPackManifest = z.object({
   schema: z.literal('v1'),
-  files: z.array(z.string())
+  description: BlockPackDescriptionManifest,
+  files: z.array(ManifestFileInfo)
 });
 export type BlockPackManifest = z.infer<typeof BlockPackManifest>;