@milaboratories/pl-model-middle-layer 1.6.1 → 1.6.2

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

@@ -2,7 +2,7 @@ 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';
+import { PTable, PTableV2 } from './table';
 /** Read interface exposed by PFrames library */
 export interface PFrameReadAPI {
     /**
@@ -25,4 +25,26 @@ export interface PFrameReadAPI {
     /** Calculate set of unique values for a specific axis for the filtered set of records */
     getUniqueValues(request: UniqueValuesRequest): Promise<UniqueValuesResponse>;
 }
+/** Read interface exposed by PFrames library */
+export interface PFrameReadAPIV2 {
+    /**
+     * 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<PTableV2>;
+    /** 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

@@ -1 +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"}
+{"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,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE3C,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;AAED,gDAAgD;AAChD,MAAM,WAAW,eAAe;IAC9B;;;;;;;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,QAAQ,CAAC,CAAC;IAE5D,yFAAyF;IACzF,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAC9E"}

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

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

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

@@ -1 +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"}
+{"version":3,"file":"pframe.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/pframe.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAE3E,MAAM,WAAW,MAAO,SAAQ,gBAAgB,EAAE,aAAa;CAC9D;AAED,MAAM,WAAW,QAAS,SAAQ,gBAAgB,EAAE,eAAe;CAClE"}

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

@@ -34,8 +34,41 @@ export interface PTable {
     /** Deallocates all underlying resources */
     dispose(): void;
 }
-export interface PTableV2 extends PTable {
+/**
+ * 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 PTableV2 {
+    /** 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[]>;
     /** Filters the table and returns new PTable instance */
-    filter(request: PTableRecordFilter[]): Promise<PTable>;
+    filter(request: PTableRecordFilter[]): Promise<PTableV2>;
+    /** Sorts the table and returns new PTable instance. */
+    sort(request: PTableSorting[]): Promise<PTableV2>;
+    /** Deallocates all underlying resources */
+    dispose(): void;
 }
 //# sourceMappingURL=table.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/table.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,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;AAED,MAAM,WAAW,QAAS,SAAQ,MAAM;IACtC,wDAAwD;IACxD,MAAM,CAAC,OAAO,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CACxD"}
+{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../../src/pframe/internal_api/table.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,gBAAgB,EAChB,kBAAkB,EAClB,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;AAED;;;;;KAKK;AACL,MAAM,WAAW,QAAQ;IACvB,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,wDAAwD;IACxD,MAAM,CAAC,OAAO,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEzD,uDAAuD;IACvD,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAElD,2CAA2C;IAC3C,OAAO,IAAI,IAAI,CAAC;CACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-model-middle-layer",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description": "Common model between middle layer and non-block UI code",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",

package/src/pframe/internal_api/api_read.ts

@@ -8,7 +8,7 @@ import {
   UniqueValuesResponse
 } from '@milaboratories/pl-model-common';
 import { CreateTableRequest } from './create_table';
-import { PTable } from './table';
+import { PTable, PTableV2 } from './table';
 
 /** Read interface exposed by PFrames library */
 export interface PFrameReadAPI {
@@ -37,3 +37,31 @@ export interface PFrameReadAPI {
   /** Calculate set of unique values for a specific axis for the filtered set of records */
   getUniqueValues(request: UniqueValuesRequest): Promise<UniqueValuesResponse>;
 }
+
+/** Read interface exposed by PFrames library */
+export interface PFrameReadAPIV2 {
+  /**
+   * 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<PTableV2>;
+
+  /** Calculate set of unique values for a specific axis for the filtered set of records */
+  getUniqueValues(request: UniqueValuesRequest): Promise<UniqueValuesResponse>;
+}

package/src/pframe/internal_api/pframe.ts

@@ -1,4 +1,7 @@
-import { PFrameReadAPI, PFrameFactoryAPI } from './index';
+import { PFrameReadAPI, PFrameFactoryAPI, PFrameReadAPIV2 } from './index';
 
 export interface PFrame extends PFrameFactoryAPI, PFrameReadAPI {
 }
+
+export interface PFrameV2 extends PFrameFactoryAPI, PFrameReadAPIV2 {
+}

package/src/pframe/internal_api/table.ts

@@ -49,7 +49,46 @@ export interface PTable {
   dispose(): void;
 }
 
-export interface PTableV2 extends PTable {
+/**
+ * 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 PTableV2 {
+  /** 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[]>;
+
   /** Filters the table and returns new PTable instance */
-  filter(request: PTableRecordFilter[]): Promise<PTable>;
+  filter(request: PTableRecordFilter[]): Promise<PTableV2>;
+
+  /** Sorts the table and returns new PTable instance. */
+  sort(request: PTableSorting[]): Promise<PTableV2>;
+
+  /** Deallocates all underlying resources */
+  dispose(): void;
 }