@platforma-sdk/model 1.8.19 → 1.10.0

package/src/render/api.ts

@@ -112,11 +112,15 @@ export class ResultPool {
    * @returns data associated with the ref
    */
   public getDataByRef(ref: Ref): PObject<TreeNodeAccessor> | undefined {
-    // https://github.com/milaboratory/platforma/issues/100
-    // @TODO use native pool method when available
-    return this.getData().entries.find(
-      (f) => f.ref.blockId === ref.blockId && f.ref.name === ref.name
-    )?.obj;
+    // @TODO remove after 1 Jan 2025; forward compatibility
+    if (typeof this.ctx.getDataFromResultPoolByRef === 'undefined')
+      return this.getData().entries.find(
+        (f) => f.ref.blockId === ref.blockId && f.ref.name === ref.name
+      )?.obj;
+    return mapPObjectData(
+      this.ctx.getDataFromResultPoolByRef(ref.blockId, ref.name),
+      (handle) => new TreeNodeAccessor(handle)
+    );
   }
 
   /**
@@ -124,11 +128,12 @@ export class ResultPool {
    * @returns object spec associated with the ref
    */
   public getSpecByRef(ref: Ref): PObjectSpec | undefined {
-    // https://github.com/milaboratory/platforma/issues/100
-    // @TODO use native pool method when available
-    return this.getSpecs().entries.find(
-      (f) => f.ref.blockId === ref.blockId && f.ref.name === ref.name
-    )?.obj;
+    // @TODO remove after 1 Jan 2025; forward compatibility
+    if (typeof this.ctx.getSpecFromResultPoolByRef === 'undefined')
+      return this.getSpecs().entries.find(
+        (f) => f.ref.blockId === ref.blockId && f.ref.name === ref.name
+      )?.obj;
+    return this.ctx.getSpecFromResultPoolByRef(ref.blockId, ref.name);
   }
 
   /**
@@ -275,9 +280,16 @@ export class RenderCtx<Args, UiState> {
     return this.ctx.createPTable(mapPTableDef(rawDef, (po) => mapPObjectData(po, (d) => d.handle)));
   }
 
+  /** @deprecated scheduled for removal from SDK */
   public getBlockLabel(blockId: string): string {
     return this.ctx.getBlockLabel(blockId);
   }
+
+  public getCurrentUnstableMarker(): string | undefined {
+    // @TODO remove after 1 Jan 2025; forward compatibility
+    if (typeof this.ctx.getCurrentUnstableMarker === 'undefined') return undefined;
+    return this.ctx.getCurrentUnstableMarker();
+  }
 }
 
 export type RenderFunction<Args = unknown, UiState = unknown, Ret = unknown> = (

package/src/render/index.ts

@@ -1,5 +1,6 @@
 export * from './api';
 export * from './traversal_ops';
 export * from './accessor';
+export * from './util';
 export { type ExtractFutureRefType } from './future';
 export { FutureRef } from './future';

package/src/render/internal.ts

@@ -11,6 +11,7 @@ import {
   PSpecPredicate,
   PTableDef,
   PTableHandle,
+  Ref,
   ResultCollection,
   ValueOrError
 } from '@milaboratories/pl-model-common';
@@ -103,6 +104,7 @@ export interface GlobalCfgRenderCtxMethods<AHandle = AccessorHandle, FHandle = F
   // Blocks
   //
 
+  /** @deprecated at some point will stop working and will return dummy values */
   getBlockLabel(blockId: string): string;
 
   //
@@ -117,6 +119,10 @@ export interface GlobalCfgRenderCtxMethods<AHandle = AccessorHandle, FHandle = F
 
   getSpecsFromResultPool(): ResultCollection<PObjectSpec>;
 
+  getSpecFromResultPoolByRef(blockId: string, exportName: string): PObjectSpec | undefined;
+
+  getDataFromResultPoolByRef(blockId: string, exportName: string): PObject<AHandle> | undefined;
+
   calculateOptions(predicate: PSpecPredicate): Option[];
 
   //
@@ -126,6 +132,12 @@ export interface GlobalCfgRenderCtxMethods<AHandle = AccessorHandle, FHandle = F
   createPFrame(def: PFrameDef<AHandle>): PFrameHandle;
 
   createPTable(def: PTableDef<PColumn<AHandle>>): PTableHandle;
+
+  //
+  // Computable
+  //
+
+  getCurrentUnstableMarker(): string | undefined;
 }
 
 export interface GlobalCfgRenderCtx extends GlobalCfgRenderCtxMethods {

package/src/render/traversal_ops.ts

@@ -46,8 +46,11 @@ export type GetFieldStep = CommonFieldTraverseOps & {
   errorIfFieldNotSet?: true;
 
   /**
-   * Assert field type. Call will fail with exception if this assertion is not
-   * fulfilled
+   * Assert field type.
+   * Call will fail with exception if this assertion is not fulfilled.
+   * The information about expectedFieldType is also used for stability
+   * calculation and field absence error generation, so it is always a good
+   * ide to specify it.
    * */
   assertFieldType?: FieldType;
 };

package/src/render/util/index.ts

@@ -0,0 +1 @@
+export * from './resource_map'

package/src/render/util/resource_map.ts

@@ -0,0 +1,74 @@
+import { TreeNodeAccessor } from "../accessor";
+
+export const ResourceMapResourceTypeName = 'PColumnData/ResourceMap';
+export const ResourceMapResourcePartitionedTypeName = 'PColumnData/Partitioned/ResourceMap';
+
+export type PColumnKey = (string | number)[];
+
+export type PColumnResourceMapEntry<T> = {
+  key: PColumnKey;
+  value: T;
+};
+
+export type PColumnResourceMapData<T> = {
+  isComplete: boolean;
+  data: PColumnResourceMapEntry<T>[];
+};
+
+function populateResourceMapData<T>(
+  acc: TreeNodeAccessor | undefined,
+  resourceParser: (acc: TreeNodeAccessor) => T | undefined,
+  data: PColumnResourceMapEntry<T | undefined>[],
+  keyPrefix: PColumnKey = [],
+  addEntriesWithNoData: boolean
+): boolean {
+  if (acc === undefined) return false;
+  switch (acc.resourceType.name) {
+    case ResourceMapResourceTypeName: {
+      let isComplete = acc.getInputsLocked();
+      for (const keyStr of acc.listInputFields()) {
+        const value = acc.resolve({ field: keyStr, assertFieldType: 'Input' });
+        const key = [...keyPrefix, ...JSON.parse(keyStr)] as PColumnKey;
+        const converted = value === undefined ? undefined : resourceParser(value);
+        if (converted === undefined) isComplete = false;
+        if (converted !== undefined || addEntriesWithNoData) data.push({ key, value: converted });
+      }
+      return isComplete;
+    }
+    case ResourceMapResourcePartitionedTypeName: {
+      let isComplete = acc.getInputsLocked();
+      for (const keyStr of acc.listInputFields()) {
+        const value = acc.resolve({ field: keyStr, assertFieldType: 'Input' });
+        if (value === undefined) isComplete = false;
+        else {
+          const key = [...keyPrefix, ...JSON.parse(keyStr)] as PColumnKey;
+          const populateResult = populateResourceMapData(value, resourceParser, data, key, addEntriesWithNoData)
+          isComplete = isComplete && populateResult;
+        }
+      }
+      return isComplete;
+    }
+    default:
+      throw new Error(`Unknown resource type: ${acc.resourceType.name}`);
+  }
+}
+
+export function parseResourceMap<T>(
+  acc: TreeNodeAccessor | undefined,
+  resourceParser: (acc: TreeNodeAccessor) => T | undefined,
+  addEntriesWithNoData: false
+): PColumnResourceMapData<NonNullable<T>>;
+export function parseResourceMap<T>(
+  acc: TreeNodeAccessor | undefined,
+  resourceParser: (acc: TreeNodeAccessor) => T | undefined,
+  addEntriesWithNoData: true
+): PColumnResourceMapData<T | undefined>;
+export function parseResourceMap<T>(
+  acc: TreeNodeAccessor | undefined,
+  resourceParser: (acc: TreeNodeAccessor) => T | undefined,
+  addEntriesWithNoData: boolean = false
+): PColumnResourceMapData<T | undefined> {
+  const data: PColumnResourceMapEntry<T | undefined>[] = [];
+  const isComplete = populateResourceMapData(acc, resourceParser, data, [], addEntriesWithNoData);
+  return { isComplete, data };
+}

package/src/typing.test.ts

@@ -4,7 +4,7 @@ import {
   RemoteBlobHandleAndSize,
   ValueOrErrors
 } from '@milaboratories/pl-model-common';
-import { BlockModel, DeriveHref, StdCtx } from './builder';
+import { BlockModel } from './builder';
 import {
   Args,
   ConfigResult,
@@ -27,6 +27,7 @@ import {
   mapRecordValues
 } from './config';
 import { InferHrefType, InferOutputsType } from './platforma';
+import { DeriveHref, StdCtx } from './bconfig';
 
 type AssertEqual<T, Expected> = [T] extends [Expected]
   ? [Expected] extends [T]
@@ -99,11 +100,11 @@ test('test config content', () => {
 });
 
 test('test config content', () => {
-  const platforma = BlockModel.create<{ a: string[] }>('Heavy')
-    .initialArgs({ a: [] })
+  const platforma = BlockModel.create('Heavy')
+    .withArgs<{ a: string[] }>({ a: [] })
+    .argsValid(isEmpty(getJsonField(Args, 'a')))
     .output('cell1', makeObject({ b: getJsonField(Args, 'a') }))
     .output('cell2', mapArrayValues(getJsonField(Args, 'a'), getImmediate('v1')))
-    .inputsValid(isEmpty(getJsonField(Args, 'a')))
     .sections((r) => {
       return [
         { type: 'link', href: '/', label: 'Main' },