@milaboratories/pl-model-middle-layer 1.7.44 → 1.7.46

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

@@ -2,9 +2,9 @@ import { FindColumnsRequest, FindColumnsResponse } from './find_columns';
 import { DeleteColumnFromColumnsRequest, DeleteColumnFromColumnsResponse } from './delete_column';
 import { PColumnInfo, PColumnSpec, PObjectId, UniqueValuesRequest, UniqueValuesResponse } from '@milaboratories/pl-model-common';
 import { CreateTableRequestV3 } from './create_table';
-import { PTableV5 } from './table';
+import { PTableV6 } from './table';
 /** Read interface exposed by PFrames library */
-export interface PFrameReadAPIV7 {
+export interface PFrameReadAPIV8 {
     /**
      * Finds columns given filtering criteria on column name, annotations etc.
      * and a set of qualified axes specs to find only columns with compatible
@@ -21,7 +21,7 @@ export interface PFrameReadAPIV7 {
     /** 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: CreateTableRequestV3): PTableV5;
+    createTable(request: CreateTableRequestV3): PTableV6;
     /** Calculate set of unique values for a specific axis for the filtered set of records */
     getUniqueValues(request: UniqueValuesRequest, ops?: {
         signal?: AbortSignal;

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

@@ -1,6 +1,6 @@
 import { PFrameFactoryAPI } from './api_factory';
-import { PFrameReadAPIV7 } from './api_read';
+import { PFrameReadAPIV8 } from './api_read';
 export type Logger = (level: 'info' | 'warn' | 'error', message: string) => void;
-export interface PFrameV7 extends PFrameFactoryAPI, PFrameReadAPIV7 {
+export interface PFrameV8 extends PFrameFactoryAPI, PFrameReadAPIV8 {
 }
 //# sourceMappingURL=pframe.d.ts.map

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

@@ -5,7 +5,7 @@ import { PTableColumnId, PTableColumnSpec, PTableRecordFilter, PTableShape, PTab
  * 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 PTableV5 {
+export interface PTableV6 {
     /**
      * Returns ordered array of table axes specs (primary key "columns" in SQL
      * terms) and data column specs (regular "columns" in SQL terms).
@@ -18,6 +18,14 @@ export interface PTableV5 {
     getSpec(): PTableColumnSpec[];
     /** Transforms unified column identifiers into unified indices of columns. */
     getColumnIndices(columnIds: PTableColumnId[]): number[];
+    /**
+     * Get PTable disk footprint in bytes
+     * Warning: This call materializes the join.
+     */
+    getFootprint(ops?: {
+        withPredecessors?: boolean;
+        signal?: AbortSignal;
+    }): Promise<number>;
     /**
      * Unified table shape
      * Warning: This call materializes the join.
@@ -39,9 +47,9 @@ export interface PTableV5 {
         signal?: AbortSignal;
     }): Promise<PTableVector[]>;
     /** Filters the table and returns new PTable instance */
-    filter(request: PTableRecordFilter[]): PTableV5;
+    filter(request: PTableRecordFilter[]): PTableV6;
     /** Sorts the table and returns new PTable instance. */
-    sort(request: PTableSorting[]): PTableV5;
+    sort(request: PTableSorting[]): PTableV6;
     /** Deallocates all underlying resources */
     dispose(): void;
 }

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,QAAQ;IACvB;;;;;;;;SAQK;IACL,OAAO,IAAI,gBAAgB,EAAE,CAAC;IAE9B,6EAA6E;IAC7E,gBAAgB,CAAC,SAAS,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC;IAExD;;;OAGG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE;QACb,MAAM,CAAC,EAAE,WAAW,CAAC;KACtB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEzB;;;;;;;;SAQK;IACL,OAAO,CACL,aAAa,EAAE,MAAM,EAAE,EACvB,GAAG,CAAC,EAAE;QACJ,KAAK,CAAC,EAAE,UAAU,CAAC;QACnB,MAAM,CAAC,EAAE,WAAW,CAAC;KACtB,GACA,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAE3B,wDAAwD;IACxD,MAAM,CAAC,OAAO,EAAE,kBAAkB,EAAE,GAAG,QAAQ,CAAC;IAEhD,uDAAuD;IACvD,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,QAAQ,CAAC;IAEzC,2CAA2C;IAC3C,OAAO,IAAI,IAAI,CAAC;CACjB"}
+{"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,QAAQ;IACvB;;;;;;;;SAQK;IACL,OAAO,IAAI,gBAAgB,EAAE,CAAC;IAE9B,6EAA6E;IAC7E,gBAAgB,CAAC,SAAS,EAAE,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC;IAExD;;;OAGG;IACH,YAAY,CAAC,GAAG,CAAC,EAAE;QACjB,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAC3B,MAAM,CAAC,EAAE,WAAW,CAAC;KACtB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,GAAG,CAAC,EAAE;QACb,MAAM,CAAC,EAAE,WAAW,CAAC;KACtB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAEzB;;;;;;;;SAQK;IACL,OAAO,CACL,aAAa,EAAE,MAAM,EAAE,EACvB,GAAG,CAAC,EAAE;QACJ,KAAK,CAAC,EAAE,UAAU,CAAC;QACnB,MAAM,CAAC,EAAE,WAAW,CAAC;KACtB,GACA,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAE3B,wDAAwD;IACxD,MAAM,CAAC,OAAO,EAAE,kBAAkB,EAAE,GAAG,QAAQ,CAAC;IAEhD,uDAAuD;IACvD,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE,GAAG,QAAQ,CAAC;IAEzC,2CAA2C;IAC3C,OAAO,IAAI,IAAI,CAAC;CACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-model-middle-layer",
-  "version": "1.7.44",
+  "version": "1.7.46",
   "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,10 +8,10 @@ import {
   UniqueValuesResponse
 } from '@milaboratories/pl-model-common';
 import { CreateTableRequestV3 } from './create_table';
-import { PTableV5 } from './table';
+import { PTableV6 } from './table';
 
 /** Read interface exposed by PFrames library */
-export interface PFrameReadAPIV7 {
+export interface PFrameReadAPIV8 {
   /**
    * Finds columns given filtering criteria on column name, annotations etc.
    * and a set of qualified axes specs to find only columns with compatible
@@ -32,7 +32,7 @@ export interface PFrameReadAPIV7 {
   listColumns(): Promise<PColumnInfo[]>;
 
   /** Calculates data for the table and returns an object to access it */
-  createTable(request: CreateTableRequestV3): PTableV5;
+  createTable(request: CreateTableRequestV3): PTableV6;
 
   /** Calculate set of unique values for a specific axis for the filtered set of records */
   getUniqueValues(

package/src/pframe/internal_api/pframe.ts

@@ -1,9 +1,9 @@
 import type { PFrameFactoryAPI } from './api_factory';
-import type { PFrameReadAPIV7 } from './api_read';
+import type { PFrameReadAPIV8 } from './api_read';
 
 export type Logger = (
   level: 'info' | 'warn' | 'error',
   message: string
 ) => void;
 
-export interface PFrameV7 extends PFrameFactoryAPI, PFrameReadAPIV7 {}
+export interface PFrameV8 extends PFrameFactoryAPI, PFrameReadAPIV8 {}

package/src/pframe/internal_api/table.ts

@@ -14,7 +14,7 @@ import {
  * 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 PTableV5 {
+export interface PTableV6 {
   /**
    * Returns ordered array of table axes specs (primary key "columns" in SQL
    * terms) and data column specs (regular "columns" in SQL terms).
@@ -29,6 +29,15 @@ export interface PTableV5 {
   /** Transforms unified column identifiers into unified indices of columns. */
   getColumnIndices(columnIds: PTableColumnId[]): number[];
 
+  /**
+   * Get PTable disk footprint in bytes
+   * Warning: This call materializes the join.
+   */
+  getFootprint(ops?: {
+    withPredecessors?: boolean,
+    signal?: AbortSignal,
+  }): Promise<number>;
+
   /**
    * Unified table shape
    * Warning: This call materializes the join.
@@ -55,10 +64,10 @@ export interface PTableV5 {
   ): Promise<PTableVector[]>;
 
   /** Filters the table and returns new PTable instance */
-  filter(request: PTableRecordFilter[]): PTableV5;
+  filter(request: PTableRecordFilter[]): PTableV6;
 
   /** Sorts the table and returns new PTable instance. */
-  sort(request: PTableSorting[]): PTableV5;
+  sort(request: PTableSorting[]): PTableV6;
 
   /** Deallocates all underlying resources */
   dispose(): void;