@platforma-sdk/model 1.24.5 → 1.24.10

package/src/pframe.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   CalculateTableDataRequest,
   CalculateTableDataResponse,
   FindColumnsRequest,
@@ -9,7 +9,7 @@ import {
   PFrameHandle,
   PObjectId,
   UniqueValuesRequest,
-  UniqueValuesResponse
+  UniqueValuesResponse,
 } from '@milaboratories/pl-model-common';
 
 export class PFrameImpl implements PFrame {
@@ -28,7 +28,7 @@ export class PFrameImpl implements PFrame {
   }
 
   public async calculateTableData(
-    request: CalculateTableDataRequest<PObjectId>
+    request: CalculateTableDataRequest<PObjectId>,
   ): Promise<CalculateTableDataResponse> {
     return await platforma.pFrameDriver.calculateTableData(this.handle, request);
   }

package/src/platforma.ts

@@ -1,16 +1,16 @@
-import { BlockApi } from './block_api';
-import { BlockOutputsBase, BlockState, DriverKit, ValueOrErrors } from '@milaboratories/pl-model-common';
-import { SdkInfo } from './sdk_info';
-import { BlockStatePatch } from './block_state_patch';
+import type { BlockApi } from './block_api';
+import type { BlockOutputsBase, BlockState, DriverKit, ValueOrErrors } from '@milaboratories/pl-model-common';
+import type { SdkInfo } from './sdk_info';
+import type { BlockStatePatch } from './block_state_patch';
 
 /** Defines all methods to interact with the platform environment from within a block UI. */
 export interface Platforma<
   Args = unknown,
   Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
   UiState = unknown,
-  Href extends `/${string}` = `/${string}`
+  Href extends `/${string}` = `/${string}`,
 > extends BlockApi<Args, Outputs, UiState, Href>,
-    DriverKit {
+  DriverKit {
   /** Information about SDK version current platforma environment was compiled with. */
   readonly sdkInfo: SdkInfo;
 }
@@ -28,7 +28,7 @@ export type InferUiState<Pl extends Platforma> =
 export type InferHrefType<Pl extends Platforma> =
   Pl extends Platforma<unknown, BlockOutputsBase, unknown, infer Href> ? Href : never;
 
-export type PlatformaFactory = (config: {sdkVersion: string}) => Platforma;
+export type PlatformaFactory = (config: { sdkVersion: string }) => Platforma;
 
 export type InferBlockState<Pl extends Platforma> = BlockState<
   InferArgsType<Pl>,

package/src/raw_globals.ts

@@ -1,6 +1,6 @@
 import {} from './global';
 import { getPlatformaInstance } from './internal';
-import { Platforma } from './platforma';
+import type { Platforma } from './platforma';
 import { PlatformaSDKVersion } from './version';
 
 export function getRawPlatformaInstance(): Platforma {

package/src/ref_util.ts

@@ -1,16 +1,17 @@
-import { getJsonField, makeObject, TypedConfig } from './config';
+import type { TypedConfig } from './config';
+import { getJsonField, makeObject } from './config';
 
 export function fromPlRef<Source extends TypedConfig>(source: Source) {
   return makeObject({
     __isRef: true,
     blockId: getJsonField(source, 'blockId'),
-    name: getJsonField(source, 'name')
+    name: getJsonField(source, 'name'),
   });
 }
 
 export function fromPlOption<Source extends TypedConfig>(source: Source) {
   return makeObject({
     ref: fromPlRef(getJsonField(source, 'ref')),
-    label: getJsonField(source, 'label')
+    label: getJsonField(source, 'label'),
   });
 }

package/src/render/accessor.ts

@@ -1,4 +1,4 @@
-import {
+import type {
   AnyLogHandle,
   ImportProgress,
   LocalBlobHandleAndSize,
@@ -7,14 +7,16 @@ import {
   RemoteBlobHandleAndSize,
   FolderURL,
   ArchiveFormat,
+  ProgressLogWithInfo,
+} from '@milaboratories/pl-model-common';
+import {
   isPColumn,
   mapPObjectData,
-  ProgressLogWithInfo
 } from '@milaboratories/pl-model-common';
 import { getCfgRenderCtx } from '../internal';
 import { FutureRef } from './future';
-import { AccessorHandle } from './internal';
-import { CommonFieldTraverseOps, FieldTraversalStep, ResourceType } from './traversal_ops';
+import type { AccessorHandle } from './internal';
+import type { CommonFieldTraverseOps, FieldTraversalStep, ResourceType } from './traversal_ops';
 
 export function ifDef<T, R>(value: T | undefined, cb: (value: T) => R): R | undefined {
   return value === undefined ? undefined : cb(value);
@@ -50,7 +52,7 @@ export class TreeNodeAccessor {
     ...steps: [
       Omit<FieldTraversalStep, 'errorIfFieldNotSet'> & {
         errorIfFieldNotAssigned: true;
-      }
+      },
     ]
   ): TreeNodeAccessor;
   /** Shortcut for {@link resolveInput} */
@@ -60,8 +62,8 @@ export class TreeNodeAccessor {
       (s) =>
         ({
           assertFieldType: 'Input',
-          ...(typeof s === 'string' ? { field: s } : s)
-        }) satisfies FieldTraversalStep
+          ...(typeof s === 'string' ? { field: s } : s),
+        }) satisfies FieldTraversalStep,
     );
     return this.resolveWithCommon({}, ...transformedSteps);
   }
@@ -71,7 +73,7 @@ export class TreeNodeAccessor {
     ...steps: [
       Omit<FieldTraversalStep, 'errorIfFieldNotSet'> & {
         errorIfFieldNotAssigned: true;
-      }
+      },
     ]
   ): TreeNodeAccessor;
   /** If field type assertion is not specified for the step, default is Output. */
@@ -81,8 +83,8 @@ export class TreeNodeAccessor {
       (s) =>
         ({
           assertFieldType: 'Output',
-          ...(typeof s === 'string' ? { field: s } : s)
-        }) satisfies FieldTraversalStep
+          ...(typeof s === 'string' ? { field: s } : s),
+        }) satisfies FieldTraversalStep,
     );
     return this.resolveWithCommon({}, ...transformedSteps);
   }
@@ -92,7 +94,7 @@ export class TreeNodeAccessor {
     ...steps: [
       Omit<FieldTraversalStep, 'errorIfFieldNotSet'> & {
         errorIfFieldNotAssigned: true;
-      }
+      },
     ]
   ): TreeNodeAccessor;
   /** If field type assertion is not specified for the step, default is Input. */
@@ -102,8 +104,8 @@ export class TreeNodeAccessor {
       (s) =>
         ({
           assertFieldType: 'Input',
-          ...(typeof s === 'string' ? { field: s } : s)
-        }) satisfies FieldTraversalStep
+          ...(typeof s === 'string' ? { field: s } : s),
+        }) satisfies FieldTraversalStep,
     );
     return this.resolveWithCommon({}, ...transformedSteps);
   }
@@ -112,7 +114,7 @@ export class TreeNodeAccessor {
     ...steps: [
       Omit<FieldTraversalStep, 'errorIfFieldNotSet'> & {
         errorIfFieldNotAssigned: true;
-      }
+      },
     ]
   ): TreeNodeAccessor;
   public resolveAny(...steps: (FieldTraversalStep | string)[]): TreeNodeAccessor | undefined;
@@ -207,7 +209,7 @@ export class TreeNodeAccessor {
    */
   public getPColumns(
     errorOnUnknownField: boolean = false,
-    prefix: string = ''
+    prefix: string = '',
   ): PColumn<TreeNodeAccessor>[] | undefined {
     const result = this.parsePObjectCollection(errorOnUnknownField, prefix);
     if (result === undefined) return undefined;
@@ -225,7 +227,7 @@ export class TreeNodeAccessor {
    */
   public parsePObjectCollection(
     errorOnUnknownField: boolean = false,
-    prefix: string = ''
+    prefix: string = '',
   ): Record<string, PObject<TreeNodeAccessor>> | undefined {
     const pObjects = getCfgRenderCtx().parsePObjectCollection(
       this.handle,
@@ -252,7 +254,7 @@ export class TreeNodeAccessor {
 
   public getFileContentAsJson<T>(): FutureRef<T | undefined> {
     return new FutureRef<string | undefined>(
-      getCfgRenderCtx().getBlobContentAsString(this.handle)
+      getCfgRenderCtx().getBlobContentAsString(this.handle),
     ).mapDefined((v) => JSON.parse(v) as T);
   }
 
@@ -329,16 +331,16 @@ export class TreeNodeAccessor {
     switch (fieldType) {
       case 'Input':
         return (
-          this.getInputsLocked() &&
-          this.listInputFields().every(
-            (field) => this.resolve({ field, assertFieldType: 'Input' }) !== undefined
+          this.getInputsLocked()
+          && this.listInputFields().every(
+            (field) => this.resolve({ field, assertFieldType: 'Input' }) !== undefined,
           )
         );
       case 'Output':
         return (
-          this.getOutputsLocked() &&
-          this.listOutputFields().every(
-            (field) => this.resolve({ field, assertFieldType: 'Output' }) !== undefined
+          this.getOutputsLocked()
+          && this.listOutputFields().every(
+            (field) => this.resolve({ field, assertFieldType: 'Output' }) !== undefined,
           )
         );
     }
@@ -354,27 +356,27 @@ export class TreeNodeAccessor {
   ): T[] | undefined;
   public mapFields<T>(
     _mapping: (name: string, value: TreeNodeAccessor) => T,
-    _ops?: FieldMapOps
+    _ops?: FieldMapOps,
   ): T[] | undefined {
     const { fieldType, requireLocked, skipUnresolved } = {
       fieldType: 'Input' as const,
       requireLocked: true,
       skipUnresolved: false,
-      ..._ops
+      ..._ops,
     };
     const mapping = _mapping as (name: string, value: TreeNodeAccessor | undefined) => T;
     if (requireLocked) {
       if (fieldType === 'Input' && !this.getInputsLocked()) return undefined;
       if (fieldType === 'Output' && !this.getOutputsLocked()) return undefined;
     }
-    const fieldList =
-      fieldType === 'Input'
+    const fieldList
+      = fieldType === 'Input'
         ? this.listInputFields()
         : fieldType === 'Output'
           ? this.listOutputFields()
           : this.listDynamicFields();
     let fieldEntries = fieldList.map(
-      (field) => [field, this.resolve({ field, assertFieldType: fieldType })] as const
+      (field) => [field, this.resolve({ field, assertFieldType: fieldType })] as const,
     );
     if (skipUnresolved) fieldEntries = fieldEntries.filter((e) => e[1] !== undefined);
     return fieldEntries.map(([name, value]) => mapping(name, value));

package/src/render/api.ts

@@ -18,10 +18,13 @@ import type {
   PTableSorting,
   PlRef,
   ResultCollection,
-  ValueOrError } from '@milaboratories/pl-model-common';
+  ValueOrError,
+  AnyFunction,
+} from '@milaboratories/pl-model-common';
 import {
   AnchorIdDeriver,
-  resolveAnchors } from '@milaboratories/pl-model-common';
+  resolveAnchors,
+} from '@milaboratories/pl-model-common';
 import {
   ensurePColumn,
   extractAllColumns,
@@ -52,7 +55,8 @@ export class ResultPool {
     return this.ctx.calculateOptions(predicate);
   }
 
-  private defaultLabelFn = (spec: PObjectSpec, ref: PlRef) =>
+  // @TODO: unused, what is this for?
+  private defaultLabelFn = (spec: PObjectSpec, _ref: PlRef) =>
     spec.annotations?.['pl7.app/label'] ?? `Unlabelled`;
 
   public getOptions(
@@ -140,7 +144,7 @@ export class ResultPool {
           resolvedAnchors[key] = resolvedSpec;
         } else {
           // It's already a PColumnSpec
-          resolvedAnchors[key] = value as PColumnSpec;
+          resolvedAnchors[key] = value;
         }
       }
     }
@@ -263,7 +267,7 @@ export class ResultPool {
     const spec = this.getSpecByRef(ref);
     if (!spec) return undefined;
     if (!isPColumnSpec(spec)) throw new Error(`not a PColumn spec (kind = ${spec.kind})`);
-    return spec as PColumnSpec;
+    return spec;
   }
 
   /**
@@ -492,6 +496,6 @@ export type UnwrapFutureRef<K> =
       ? K
       : { [key in keyof K]: UnwrapFutureRef<K[key]> };
 
-export type InferRenderFunctionReturn<RF extends Function> = RF extends (...args: any) => infer R
+export type InferRenderFunctionReturn<RF extends AnyFunction> = RF extends (...args: any) => infer R
   ? UnwrapFutureRef<R>
   : never;

package/src/render/future.ts

@@ -1,4 +1,4 @@
-import { FutureAwait, FutureHandle } from './internal';
+import type { FutureAwait, FutureHandle } from './internal';
 import { registerFutureAwait } from '../internal';
 
 export class FutureRef<T = unknown> {
@@ -7,7 +7,7 @@ export class FutureRef<T = unknown> {
 
   constructor(
     private readonly handle: FutureHandle,
-    private readonly postProcess: (value: unknown) => T = (v) => v as T
+    private readonly postProcess: (value: unknown) => T = (v) => v as T,
   ) {
     registerFutureAwait(handle, (value) => {
       this.resolvedValue = postProcess(value);
@@ -26,7 +26,7 @@ export class FutureRef<T = unknown> {
     });
   }
 
-  toJSON(): any {
+  toJSON() {
     return this.isResolved
       ? this.resolvedValue
       : ({ __awaited_futures__: [this.handle] } as FutureAwait);

package/src/render/internal.ts

@@ -1,8 +1,9 @@
-import { Optional } from 'utility-types';
-import { Branded } from '../branding';
-import { CommonFieldTraverseOps, FieldTraversalStep, ResourceType } from './traversal_ops';
-import {
+import type { Optional } from 'utility-types';
+import type { Branded } from '../branding';
+import type { CommonFieldTraverseOps, FieldTraversalStep, ResourceType } from './traversal_ops';
+import type {
   ArchiveFormat,
+  AnyFunction,
   Option,
   PColumn,
   PColumnValues,
@@ -13,9 +14,8 @@ import {
   PSpecPredicate,
   PTableDef,
   PTableHandle,
-  Ref,
   ResultCollection,
-  ValueOrError
+  ValueOrError,
 } from '@milaboratories/pl-model-common';
 
 export const StagingAccessorName = 'staging';
@@ -153,7 +153,7 @@ export interface GlobalCfgRenderCtxMethods<AHandle = AccessorHandle, FHandle = F
 
 export const GlobalCfgRenderCtxFeatureFlags = {
   inlineColumnsSupport: true as const,
-  activeArgs: true as const
+  activeArgs: true as const,
 };
 
 export interface GlobalCfgRenderCtx extends GlobalCfgRenderCtxMethods {
@@ -163,7 +163,7 @@ export interface GlobalCfgRenderCtx extends GlobalCfgRenderCtxMethods {
   readonly args: string;
   readonly uiState: string;
   readonly activeArgs?: string;
-  readonly callbackRegistry: Record<string, Function>;
+  readonly callbackRegistry: Record<string, AnyFunction>;
   readonly featureFlags?: typeof GlobalCfgRenderCtxFeatureFlags;
 }
 

package/src/render/util/label.ts

@@ -1,4 +1,4 @@
-import { PObjectSpec } from '@milaboratories/pl-model-common';
+import type { PObjectSpec } from '@milaboratories/pl-model-common';
 import { z } from 'zod';
 
 export const PAnnotationLabel = 'pl7.app/label';
@@ -22,7 +22,7 @@ export const TraceEntry = z.object({
   type: z.string(),
   importance: z.number().optional(),
   id: z.string().optional(),
-  label: z.string()
+  label: z.string(),
 });
 export type TraceEntry = z.infer<typeof TraceEntry>;
 type FullTraceEntry = TraceEntry & { fullType: string; occurenceIndex: number };
@@ -39,7 +39,7 @@ const LabelTypeFull = '__LABEL__@1';
 export function deriveLabels<T>(
   values: T[],
   specExtractor: (obj: T) => PObjectSpec,
-  ops: LabelDerivationOps = {}
+  ops: LabelDerivationOps = {},
 ): RecordsWithLabel<T>[] {
   const importances = new Map<string, number>();
 
@@ -72,8 +72,8 @@ export function deriveLabels<T>(
         fullType,
         Math.max(
           importances.get(fullType) ?? Number.NEGATIVE_INFINITY,
-          importance - (trace.length - i) * DistancePenalty
-        )
+          importance - (trace.length - i) * DistancePenalty,
+        ),
       );
       fullTrace.push({ ...trace[i], fullType, occurenceIndex });
     }
@@ -82,7 +82,7 @@ export function deriveLabels<T>(
       value,
       spec,
       label,
-      fullTrace
+      fullTrace,
     };
   });
 
@@ -109,7 +109,7 @@ export function deriveLabels<T>(
       const sep = ops.separator ?? ' / ';
       return {
         label: labelSet.join(sep),
-        value: r.value
+        value: r.value,
       } satisfies RecordsWithLabel<T>;
     });
 

package/src/render/util/resource_map.ts

@@ -1,4 +1,4 @@
-import { TreeNodeAccessor } from '../accessor';
+import type { TreeNodeAccessor } from '../accessor';
 
 const PCD_PREFIX = 'PColumnData/';
 
@@ -29,7 +29,7 @@ function populateResourceMapData<T>(
   resourceParser: (acc: TreeNodeAccessor) => T | undefined,
   data: PColumnResourceMapEntry<T | undefined>[],
   keyPrefix: PColumnKey = [],
-  addEntriesWithNoData: boolean
+  addEntriesWithNoData: boolean,
 ): boolean {
   if (acc === undefined) return false;
   switch (acc.resourceType.name) {
@@ -56,7 +56,7 @@ function populateResourceMapData<T>(
             resourceParser,
             data,
             key,
-            addEntriesWithNoData
+            addEntriesWithNoData,
           );
           isComplete = isComplete && populateResult;
         }
@@ -81,14 +81,13 @@ export function parseResourceMap<T>(
 export function parseResourceMap<T>(
   acc: TreeNodeAccessor | undefined,
   resourceParser: (acc: TreeNodeAccessor) => T | undefined,
-  addEntriesWithNoData: boolean = false
+  addEntriesWithNoData: boolean = false,
 ): PColumnResourceMapData<T | undefined> {
   const data: PColumnResourceMapEntry<T | undefined>[] = [];
   const isComplete = populateResourceMapData(acc, resourceParser, data, [], addEntriesWithNoData);
   return { isComplete, data };
 }
 
-
 export type PColumnKeyList = {
   /** array of keys */
   data: PColumnKey[];
@@ -109,7 +108,7 @@ const removeIndexSuffix = (keyStr: string): string | undefined => {
 // @TODO define a class with various resource map operations
 /** Returns a list of all partition keys appeared in the p-column */
 export function getPartitionKeysList(
-  acc: TreeNodeAccessor | undefined
+  acc: TreeNodeAccessor | undefined,
 ): PColumnKeyList | undefined {
   if (!acc) return undefined;
 
@@ -183,7 +182,7 @@ export function getPartitionKeysList(
 /** Returns an array of unique partition keys for each column: the i-th element in the resulting 2d array contains all unique values of i-th partition axis. */
 // @TODO define a class with various resource map operations
 export function getUniquePartitionKeys(
-  acc: TreeNodeAccessor | undefined
+  acc: TreeNodeAccessor | undefined,
 ): (string | number)[][] | undefined {
   const list = getPartitionKeysList(acc);
   if (!list) return undefined;

package/src/sdk_info.ts

@@ -5,5 +5,5 @@ export type SdkInfo = {
 };
 
 export const CurrentSdkInfo: SdkInfo = {
-  sdkVersion: PlatformaSDKVersion
+  sdkVersion: PlatformaSDKVersion,
 };