@milaboratories/pl-model-common 1.10.5 → 1.11.0

package/src/drivers/pframe/{spec.ts → spec/spec.ts}

@@ -1,4 +1,4 @@
-import { PObject, PObjectId, PObjectSpec } from '../../pool';
+import type { PObject, PObjectId, PObjectSpec } from '../../../pool';
 
 /** PFrame columns and axes within them may store one of these types. */
 export type ValueType = 'Int' | 'Long' | 'Float' | 'Double' | 'String' | 'Bytes';
@@ -61,13 +61,13 @@ export type AxesSpec = AxisSpec[];
  *
  * Each element in tuple correspond to the axis having the same index in axesSpec.
  * */
-export interface PColumnSpec extends PObjectSpec {
+export interface PUniversalColumnSpec extends PObjectSpec {
   /** Defines specific type of BObject, the most generic type of unit of
    * information in Platforma Project. */
   readonly kind: 'PColumn';
 
   /** Type of column values */
-  readonly valueType: ValueType;
+  readonly valueType: string;
 
   /** Column name */
   readonly name: string;
@@ -87,6 +87,22 @@ export interface PColumnSpec extends PObjectSpec {
   readonly axesSpec: AxesSpec;
 }
 
+/**
+ * Specification of a data column.
+ *
+ * Data column is a specialized type of PColumn that stores only simple values (strings and numbers)
+ * addressed by multiple keys. This is in contrast to other PColumn variants that can store more complex
+ * values like files or other abstract data types. Data columns are optimized for storing and processing
+ * basic tabular data.
+ */
+export interface PDataColumnSpec extends PUniversalColumnSpec {
+  /** Type of column values */
+  readonly valueType: ValueType;
+}
+
+// @todo: change this to PUniversalColumnSpec
+export type PColumnSpec = PDataColumnSpec;
+
 export interface PColumn<Data> extends PObject<Data> {
   /** PColumn spec, allowing it to be found among other PObjects */
   readonly spec: PColumnSpec;

package/src/drivers/pframe/table_common.ts

@@ -1,5 +1,5 @@
 import { PObjectId } from '../../pool';
-import { AxisId, AxisSpec, PColumnSpec } from './spec';
+import { AxisId, AxisSpec, PColumnSpec } from './spec/spec';
 
 /** Unified spec object for axes and columns */
 export type PTableColumnSpec =

package/src/drivers/pframe/unique_values.ts

@@ -1,4 +1,4 @@
-import { AxisId } from './spec';
+import { AxisId } from './spec/spec';
 import { PTableRecordFilter } from './table_calculate';
 import { PTableVector } from './data';
 import { PObjectId } from '../../pool';

package/src/ref.ts

@@ -19,6 +19,23 @@ export type PlRef = z.infer<typeof PlRef>;
 /** @deprecated use {@link PlRef} */
 export type Ref = PlRef;
 
+/**
+ * Type guard to check if a value is a PlRef.
+ * 
+ * @param value - The value to check.
+ * @returns True if the value is a PlRef, false otherwise.
+ */
+export function isPlRef(value: unknown): value is PlRef {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    '__isRef' in value &&
+    (value as { __isRef: unknown }).__isRef === true &&
+    'blockId' in value &&
+    'name' in value
+  );
+}
+
 /** Standard way how to communicate possible connections given specific
  * requirements for incoming data. */
 export type Option = {

package/dist/drivers/pframe/spec.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"spec.d.ts","sourceRoot":"","sources":["../../../src/drivers/pframe/spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE7D,wEAAwE;AACxE,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAEjF;;;;;;;KAOK;AACL,MAAM,WAAW,QAAQ;IACvB,iFAAiF;IACjF,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAEzB,uBAAuB;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;2BACuB;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC;oBACgB;IAChB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE9C;;;;;;;;;;;;;;;;;OAiBG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CAChC;AAED,iEAAiE;AACjE,MAAM,MAAM,QAAQ,GAAG,QAAQ,EAAE,CAAC;AAElC;;;;;;;;;;KAUK;AACL,MAAM,WAAW,WAAY,SAAQ,WAAW;IAC9C;2CACuC;IACvC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAEzB,4BAA4B;IAC5B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B,kBAAkB;IAClB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;2BACuB;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEzC;oBACgB;IAChB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE9C,mFAAmF;IACnF,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B,0BAA0B;IAC1B,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;CAC7B;AAED,MAAM,WAAW,OAAO,CAAC,IAAI,CAAE,SAAQ,OAAO,CAAC,IAAI,CAAC;IAClD,iEAAiE;IACjE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;CAC5B;AAED;sCACsC;AACtC,MAAM,WAAW,gBAAgB;IAC/B,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B,kBAAkB;IAClB,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;CAC5B;AAED,gEAAgE;AAChE,MAAM,WAAW,WAAY,SAAQ,gBAAgB;IACnD,oDAAoD;IACpD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,MAAM;IACrB;qCACiC;IACjC,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IAEzB,iCAAiC;IACjC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAEtB;2BACuB;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC1C;AAED,wBAAwB;AACxB,MAAM,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC;AAE9B,uCAAuC;AACvC,wBAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAGhD;AAED,8DAA8D;AAC9D,wBAAgB,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,CAEhD;AAYD,qEAAqE;AACrE,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAElE"}