@milaboratories/pl-tree 1.4.2 → 1.4.4

package/dist/sync.d.ts

@@ -23,13 +23,13 @@ export interface TreeLoadingRequest {
 export declare function constructTreeLoadingRequest(tree: PlTreeState, pruningFunction?: PruningFunction): TreeLoadingRequest;
 export type TreeLoadingStat = {
     requests: number;
-    roundtrips: number;
+    roundTrips: number;
     retrievedResources: number;
     retrievedFields: number;
     retrievedKeyValues: number;
     retrievedResourceDataBytes: number;
     retrievedKeyValueBytes: number;
-    prunnedFields: number;
+    prunedFields: number;
     finalResourcesSkipped: number;
     millisSpent: number;
 };

package/dist/sync.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../src/sync.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAIT,aAAa,EACb,UAAU,EACX,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAG5D,kDAAkD;AAClD,MAAM,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,oBAAoB,KAAK,SAAS,EAAE,CAAC;AAE9E,MAAM,WAAW,kBAAkB;IACjC;;cAEU;IACV,QAAQ,CAAC,aAAa,EAAE,UAAU,EAAE,CAAC;IAErC;;gCAE4B;IAC5B,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAEzC;;;;8BAI0B;IAC1B,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;CAC5C;AAED;kDACkD;AAClD,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,WAAW,EACjB,eAAe,CAAC,EAAE,eAAe,GAChC,kBAAkB,CAYpB;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,0BAA0B,EAAE,MAAM,CAAC;IACnC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,wBAAgB,sBAAsB,IAAI,eAAe,CAaxD;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CAYnE;AAED;;+BAE+B;AAC/B,wBAAsB,aAAa,CACjC,EAAE,EAAE,aAAa,EACjB,cAAc,EAAE,kBAAkB,EAClC,KAAK,CAAC,EAAE,eAAe,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAmHjC"}
+{"version":3,"file":"sync.d.ts","sourceRoot":"","sources":["../src/sync.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EAGT,aAAa,EACb,UAAU,EACX,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAE,oBAAoB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAG5D,kDAAkD;AAClD,MAAM,MAAM,eAAe,GAAG,CAAC,QAAQ,EAAE,oBAAoB,KAAK,SAAS,EAAE,CAAC;AAE9E,MAAM,WAAW,kBAAkB;IACjC;;cAEU;IACV,QAAQ,CAAC,aAAa,EAAE,UAAU,EAAE,CAAC;IAErC;;gCAE4B;IAC5B,QAAQ,CAAC,cAAc,EAAE,GAAG,CAAC,UAAU,CAAC,CAAC;IAEzC;;;;8BAI0B;IAC1B,QAAQ,CAAC,eAAe,CAAC,EAAE,eAAe,CAAC;CAC5C;AAED;kDACkD;AAClD,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,WAAW,EACjB,eAAe,CAAC,EAAE,eAAe,GAChC,kBAAkB,CAYpB;AAED,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,0BAA0B,EAAE,MAAM,CAAC;IACnC,sBAAsB,EAAE,MAAM,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;IACrB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,wBAAgB,sBAAsB,IAAI,eAAe,CAaxD;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CAYnE;AAED;;+BAE+B;AAC/B,wBAAsB,aAAa,CACjC,EAAE,EAAE,aAAa,EACjB,cAAc,EAAE,kBAAkB,EAClC,KAAK,CAAC,EAAE,eAAe,GACtB,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAmHjC"}

package/dist/synchronized_tree.d.ts

@@ -1,11 +1,13 @@
 import { PlTreeEntry } from './accessors';
-import { PlClient, ResourceId } from '@milaboratories/pl-client';
-import { FinalPredicate } from './state';
+import { FinalResourceDataPredicate, PlClient, ResourceId } from '@milaboratories/pl-client';
 import { PruningFunction } from './sync';
 import { MiLogger } from '@milaboratories/ts-helpers';
 type StatLoggingMode = 'cumulative' | 'per-request';
 export type SynchronizedTreeOps = {
-    finalPredicate?: FinalPredicate;
+    /** Override final predicate from the PlClient */
+    finalPredicateOverride?: FinalResourceDataPredicate;
+    /** Pruning function to limit set of fields through which tree will
+     * traverse during state synchronization */
     pruning?: PruningFunction;
     /** Interval after last sync to sleep before the next one */
     pollingInterval: number;

package/dist/synchronized_tree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"synchronized_tree.d.ts","sourceRoot":"","sources":["../src/synchronized_tree.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAA0B,QAAQ,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AACzF,OAAO,EAAE,cAAc,EAAqC,MAAM,SAAS,CAAC;AAC5E,OAAO,EAIL,eAAe,EAEhB,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAEtD,KAAK,eAAe,GAAG,YAAY,GAAG,aAAa,CAAC;AAEpD,MAAM,MAAM,mBAAmB,GAAG;IAChC,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B,4DAA4D;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,2EAA2E;IAC3E,gBAAgB,EAAE,MAAM,CAAC;IAEzB,wEAAwE;IACxE,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC;AAOF,qBAAa,qBAAqB;IAU9B,OAAO,CAAC,QAAQ,CAAC,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAErB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAZ1B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA6B;IAC5D,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;IAC/C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAyB;IAEzD,OAAO;IAoBP,sCAAsC;IAC/B,QAAQ,CAAC,GAAG,GAAE,UAAsB,GAAG,WAAW;IAKlD,KAAK,CAAC,GAAG,GAAE,UAAsB,GAAG,WAAW;IAKtD;wDACoD;IACvC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAK1C,OAAO,CAAC,oBAAoB,CAA0B;IAEtD,OAAO,CAAC,mBAAmB;IAK3B,2BAA2B;IAC3B,OAAO,CAAC,aAAa;IAMrB,2BAA2B;IAC3B,OAAO,CAAC,YAAY;IAIpB,yDAAyD;IACzD,OAAO,CAAC,WAAW,CAAS;IAC5B,iCAAiC;IACjC,OAAO,CAAC,WAAW,CAAwC;IAE3D,iEAAiE;YACnD,OAAO;IASrB,wDAAwD;IACxD,OAAO,CAAC,UAAU,CAAS;YAEb,QAAQ;IAqEtB;;;SAGK;IACQ,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAWvC,kBAAkB;IACL,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;WAKlC,IAAI,CACtB,EAAE,EAAE,QAAQ,EACZ,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,mBAAmB,EACxB,MAAM,CAAC,EAAE,QAAQ;CAapB"}
+{"version":3,"file":"synchronized_tree.d.ts","sourceRoot":"","sources":["../src/synchronized_tree.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EACL,0BAA0B,EAE1B,QAAQ,EACR,UAAU,EACX,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAIL,eAAe,EAEhB,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,QAAQ,EAAE,MAAM,4BAA4B,CAAC;AAEtD,KAAK,eAAe,GAAG,YAAY,GAAG,aAAa,CAAC;AAEpD,MAAM,MAAM,mBAAmB,GAAG;IAChC,iDAAiD;IACjD,sBAAsB,CAAC,EAAE,0BAA0B,CAAC;IAEpD;+CAC2C;IAC3C,OAAO,CAAC,EAAE,eAAe,CAAC;IAE1B,4DAA4D;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,2EAA2E;IAC3E,gBAAgB,EAAE,MAAM,CAAC;IAEzB,wEAAwE;IACxE,OAAO,CAAC,EAAE,eAAe,CAAC;CAC3B,CAAC;AAOF,qBAAa,qBAAqB;IAU9B,OAAO,CAAC,QAAQ,CAAC,EAAE;IACnB,OAAO,CAAC,QAAQ,CAAC,IAAI;IAErB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;IAZ1B,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA6B;IAC5D,OAAO,CAAC,KAAK,CAAc;IAC3B,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAkB;IAC3C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAyB;IAC/C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAyB;IAEzD,OAAO;IAoBP,sCAAsC;IAC/B,QAAQ,CAAC,GAAG,GAAE,UAAsB,GAAG,WAAW;IAKlD,KAAK,CAAC,GAAG,GAAE,UAAsB,GAAG,WAAW;IAKtD;wDACoD;IACvC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;IAK1C,OAAO,CAAC,oBAAoB,CAA0B;IAEtD,OAAO,CAAC,mBAAmB;IAK3B,2BAA2B;IAC3B,OAAO,CAAC,aAAa;IAMrB,2BAA2B;IAC3B,OAAO,CAAC,YAAY;IAIpB,yDAAyD;IACzD,OAAO,CAAC,WAAW,CAAS;IAC5B,iCAAiC;IACjC,OAAO,CAAC,WAAW,CAAwC;IAE3D,iEAAiE;YACnD,OAAO;IASrB,wDAAwD;IACxD,OAAO,CAAC,UAAU,CAAS;YAEb,QAAQ;IAqEtB;;;SAGK;IACQ,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAWvC,kBAAkB;IACL,wBAAwB,IAAI,OAAO,CAAC,IAAI,CAAC;WAKlC,IAAI,CACtB,EAAE,EAAE,QAAQ,EACZ,IAAI,EAAE,UAAU,EAChB,GAAG,EAAE,mBAAmB,EACxB,MAAM,CAAC,EAAE,QAAQ;CAapB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-tree",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "description": "Reactive pl tree state",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -20,8 +20,8 @@
     "denque": "^2.1.0",
     "utility-types": "^3.11.0",
     "zod": "^3.23.8",
-    "@milaboratories/computable": "^2.1.13",
-    "@milaboratories/pl-client": "^2.5.1",
+    "@milaboratories/pl-client": "^2.5.3",
+    "@milaboratories/computable": "^2.2.0",
     "@milaboratories/ts-helpers": "^1.1.0"
   },
   "devDependencies": {

package/src/accessors.ts

@@ -407,7 +407,7 @@ export class PlTreeNodeAccessor {
   }
 
   /**
-   * Can be used to passe a higher level accessor that will wrap the resource and throw its
+   * Can be used to pass a higher level accessor that will wrap the resource and throw its
    * errors on node resolution.
    * */
   public toEntryAccessor(): PlTreeEntryAccessor {

package/src/snapshot.test.ts

@@ -11,7 +11,7 @@ import {
 } from './test_utils';
 import { PlTreeState } from './state';
 import { Computable } from '@milaboratories/computable';
-import { ResourceId } from '@milaboratories/pl-client';
+import { DefaultFinalResourceDataPredicate, ResourceId } from '@milaboratories/pl-client';
 
 // schema definition
 const MyTestResourceState = rsSchema({
@@ -26,7 +26,7 @@ const MyTestResourceState = rsSchema({
 type MyTestResourceState = InferSnapshot<typeof MyTestResourceState>;
 
 test('simple snapshot test', async () => {
-  const tree = new PlTreeState(TestDynamicRootId1);
+  const tree = new PlTreeState(TestDynamicRootId1, DefaultFinalResourceDataPredicate);
 
   const c1 = Computable.make((ctx) => {
     const accessor = ctx.accessor(tree.entry()).node().traverse('a');

package/src/snapshot.ts

@@ -132,6 +132,8 @@ export function makeResourceSnapshot<Schema extends ResourceSnapshotSchemaGeneri
 
   if (schema.fields !== undefined) {
     const fields: Record<string, ResourceId | undefined> = {};
+    // even if field is not defined, corresponding object field
+    // with "undefined" value will still be added
     for (const [fieldName, required] of Object.entries(schema.fields))
       fields[fieldName] = node.traverse({
         field: fieldName,

package/src/state.test.ts

@@ -11,14 +11,14 @@ import {
   TestErrorResourceState2
 } from './test_utils';
 import { Computable } from '@milaboratories/computable';
-import { NullResourceId, ResourceId } from '@milaboratories/pl-client';
+import { DefaultFinalResourceDataPredicate, NullResourceId, ResourceId } from '@milaboratories/pl-client';
 
 function rid(id: bigint): ResourceId {
   return id as ResourceId;
 }
 
 test('simple tree test 1', async () => {
-  const tree = new PlTreeState(TestDynamicRootId1);
+  const tree = new PlTreeState(TestDynamicRootId1, DefaultFinalResourceDataPredicate);
   const entry = tree.entry();
   expect(isPlTreeEntry(entry)).toStrictEqual(true);
   const c1 = Computable.make((c) => {
@@ -68,7 +68,7 @@ test('simple tree test 1', async () => {
 });
 
 test('simple tree kv test', async () => {
-  const tree = new PlTreeState(TestDynamicRootId1);
+  const tree = new PlTreeState(TestDynamicRootId1, DefaultFinalResourceDataPredicate);
   const c1 = Computable.make((c) =>
     c.accessor(tree.entry()).node().traverse('a', 'b')?.getKeyValueAsString('thekey')
   );
@@ -121,7 +121,7 @@ test('simple tree kv test', async () => {
 });
 
 test('partial tree update', async () => {
-  const tree = new PlTreeState(TestDynamicRootId1);
+  const tree = new PlTreeState(TestDynamicRootId1, DefaultFinalResourceDataPredicate);
   const c1 = Computable.make((c) =>
     c
       .accessor(tree.entry())
@@ -157,7 +157,7 @@ test('partial tree update', async () => {
 });
 
 test('resource error', async () => {
-  const tree = new PlTreeState(TestDynamicRootId1);
+  const tree = new PlTreeState(TestDynamicRootId1, DefaultFinalResourceDataPredicate);
   const c1 = Computable.make((c) =>
     c.accessor(tree.entry()).node().traverse('a', 'b')?.getKeyValueAsString('thekey')
   );
@@ -180,7 +180,7 @@ test('resource error', async () => {
 });
 
 test('field error', async () => {
-  const tree = new PlTreeState(TestDynamicRootId1);
+  const tree = new PlTreeState(TestDynamicRootId1, DefaultFinalResourceDataPredicate);
   const c1 = Computable.make((c) =>
     c.accessor(tree.entry()).node().traverse('b', 'a')?.getKeyValueAsString('thekey')
   );
@@ -206,7 +206,7 @@ test('field error', async () => {
 });
 
 test('exception - deletion of input field', () => {
-  const tree = new PlTreeState(TestDynamicRootId1);
+  const tree = new PlTreeState(TestDynamicRootId1, DefaultFinalResourceDataPredicate);
 
   tree.updateFromResourceData([
     { ...TestDynamicRootState1, fields: [dField('b'), dField('a', rid(1n))] },
@@ -224,7 +224,7 @@ test('exception - deletion of input field', () => {
 });
 
 test('exception - addition of input field', () => {
-  const tree = new PlTreeState(TestDynamicRootId1);
+  const tree = new PlTreeState(TestDynamicRootId1, DefaultFinalResourceDataPredicate);
 
   tree.updateFromResourceData([
     { ...TestDynamicRootState1, fields: [dField('b'), dField('a', rid(1n))] },
@@ -254,7 +254,7 @@ test('exception - addition of input field', () => {
 });
 
 test('exception - ready without locks 1', () => {
-  const tree = new PlTreeState(TestDynamicRootId1);
+  const tree = new PlTreeState(TestDynamicRootId1, DefaultFinalResourceDataPredicate);
 
   expect(() =>
     tree.updateFromResourceData([
@@ -278,7 +278,7 @@ test('exception - ready without locks 1', () => {
 });
 
 test('exception - ready without locks 2', () => {
-  const tree = new PlTreeState(TestDynamicRootId1);
+  const tree = new PlTreeState(TestDynamicRootId1, DefaultFinalResourceDataPredicate);
 
   tree.updateFromResourceData([
     { ...TestDynamicRootState1, fields: [dField('b'), dField('a', rid(1n))] },

package/src/state.ts

@@ -1,5 +1,7 @@
 import {
   BasicResourceData,
+  FieldData,
+  FieldStatus,
   FieldType,
   isNotNullResourceId,
   isNullResourceId,
@@ -17,7 +19,8 @@ import { ChangeSource, Watcher } from '@milaboratories/computable';
 import { PlTreeEntry } from './accessors';
 import { ValueAndError } from './value_and_error';
 import { MiLogger, notEmpty } from '@milaboratories/ts-helpers';
-import { FieldTraversalStep, GetFieldStep, ResourceTraversalOps } from './traversal_ops';
+import { FieldTraversalStep, GetFieldStep } from './traversal_ops';
+import { FinalResourceDataPredicate } from '@milaboratories/pl-client';
 
 export type ExtendedResourceData = ResourceData & {
   kv: KeyValue[];
@@ -29,20 +32,16 @@ export class TreeStateUpdateError extends Error {
   }
 }
 
-/** Interface of PlTreeResource exposed to outer world, like {@link FinalPredicate}. */
-export interface PlTreeFieldI {
-  readonly type: FieldType;
-  readonly value: OptionalResourceId;
-  readonly error: OptionalResourceId;
-}
-
-class PlTreeField {
+class PlTreeField implements FieldData {
   readonly change = new ChangeSource();
 
   constructor(
+    public readonly name: string,
     public type: FieldType,
     public value: OptionalResourceId,
     public error: OptionalResourceId,
+    public status: FieldStatus,
+    public valueIsFinal: boolean,
     /** Last version of resource this field was observed, used to garbage collect fields in tree patching procedure */
     public resourceVersion: number
   ) {}
@@ -52,18 +51,12 @@ const InitialResourceVersion = 0;
 
 const decoder = new TextDecoder();
 
-/** Interface of PlTreeResource exposed to outer world, like {@link FinalPredicate}. */
-export type PlTreeResourceI = BasicResourceData & {
-  readonly final: boolean;
-  readonly fields: Map<string, PlTreeFieldI>;
+export type ResourceDataWithFinalState = ResourceData & {
+  finalState: boolean;
 };
 
-/** Predicate of resource state used to determine if it's state is considered to be final,
- * and not expected to change in the future. */
-export type FinalPredicate = (r: Omit<PlTreeResourceI, 'final'>) => boolean;
-
 /** Never store instances of this class, always get fresh instance from {@link PlTreeState} */
-export class PlTreeResource implements PlTreeResourceI {
+export class PlTreeResource implements ResourceDataWithFinalState {
   /** Tracks number of other resources referencing this resource. Used to perform garbage collection in tree patching procedure */
   refCount: number = 0;
 
@@ -72,7 +65,7 @@ export class PlTreeResource implements PlTreeResourceI {
   /** Set to resource version when resource state, or it's fields have changed */
   dataVersion: number = InitialResourceVersion;
 
-  readonly fields: Map<string, PlTreeField> = new Map();
+  readonly fieldsMap: Map<string, PlTreeField> = new Map();
 
   readonly kv = new Map<string, Uint8Array>();
 
@@ -108,8 +101,8 @@ export class PlTreeResource implements PlTreeResourceI {
   resourceReady: boolean;
   finalFlag: boolean;
 
-  /** Set externally by the tree, using {@link FinalPredicate} */
-  _final: boolean = false;
+  /** Set externally by the tree, using {@link FinalResourceDataPredicate} */
+  _finalState: boolean = false;
 
   private readonly logger?: MiLogger;
 
@@ -138,7 +131,15 @@ export class PlTreeResource implements PlTreeResourceI {
   }
 
   get final(): boolean {
-    return this._final;
+    return this.finalFlag;
+  }
+
+  get finalState(): boolean {
+    return this._finalState;
+  }
+
+  get fields(): FieldData[] {
+    return [...this.fieldsMap.values()];
   }
 
   public getField(
@@ -160,7 +161,7 @@ export class PlTreeResource implements PlTreeResourceI {
   ): ValueAndError<ResourceId> | undefined {
     const step: FieldTraversalStep = typeof _step === 'string' ? { field: _step } : _step;
 
-    const field = this.fields.get(step.field);
+    const field = this.fieldsMap.get(step.field);
     if (field === undefined) {
       if (step.errorIfFieldNotFound || step.errorIfFieldNotSet)
         throw new Error(
@@ -184,7 +185,7 @@ export class PlTreeResource implements PlTreeResourceI {
       }
 
       this.dynamicFieldListChanged?.attachWatcher(watcher);
-      if (!this._final && !step.stableIfNotFound) onUnstable('field_not_found:' + step.field);
+      if (!this._finalState && !step.stableIfNotFound) onUnstable('field_not_found:' + step.field);
 
       return undefined;
     } else {
@@ -198,7 +199,7 @@ export class PlTreeResource implements PlTreeResourceI {
       if (isNotNullResourceId(field.error)) ret.error = field.error;
       if (ret.value === undefined && ret.error === undefined)
         // this method returns value and error of the field, thus those values are considered to be accessed;
-        // any existing but not resolved field here is considered to be unstable, in the sence it is
+        // any existing but not resolved field here is considered to be unstable, in the sense it is
         // considered to acquire some resolved value eventually
         onUnstable('field_not_resolved:' + step.field);
       field.change.attachWatcher(watcher);
@@ -230,7 +231,7 @@ export class PlTreeResource implements PlTreeResourceI {
 
   public getIsFinal(watcher: Watcher): boolean {
     this.finalChanged?.attachWatcher(watcher);
-    return this._final;
+    return this._finalState;
   }
 
   public getIsReadyOrError(watcher: Watcher): boolean {
@@ -252,7 +253,7 @@ export class PlTreeResource implements PlTreeResourceI {
 
   public listInputFields(watcher: Watcher): string[] {
     const ret: string[] = [];
-    this.fields.forEach((field, name) => {
+    this.fieldsMap.forEach((field, name) => {
       if (field.type === 'Input' || field.type === 'Service') ret.push(name);
     });
     if (!this.inputsLocked) this.inputAndServiceFieldListChanged?.attachWatcher(watcher);
@@ -262,7 +263,7 @@ export class PlTreeResource implements PlTreeResourceI {
 
   public listOutputFields(watcher: Watcher): string[] {
     const ret: string[] = [];
-    this.fields.forEach((field, name) => {
+    this.fieldsMap.forEach((field, name) => {
       if (field.type === 'Output') ret.push(name);
     });
     if (!this.outputsLocked) this.outputFieldListChanged?.attachWatcher(watcher);
@@ -272,7 +273,7 @@ export class PlTreeResource implements PlTreeResourceI {
 
   public listDynamicFields(watcher: Watcher): string[] {
     const ret: string[] = [];
-    this.fields.forEach((field, name) => {
+    this.fieldsMap.forEach((field, name) => {
       if (field.type !== 'Input' && field.type !== 'Output') ret.push(name);
     });
     this.dynamicFieldListChanged?.attachWatcher(watcher);
@@ -323,10 +324,11 @@ export class PlTreeResource implements PlTreeResourceI {
     };
   }
 
+  /** Called when {@link FinalResourceDataPredicate} returns true for the state. */
   markFinal() {
-    if (this._final) return;
+    if (this._finalState) return;
 
-    this._final = true;
+    this._finalState = true;
     notEmpty(this.finalChanged).markChanged();
     this.finalChanged = undefined;
     this.resourceStateChange = undefined;
@@ -338,7 +340,7 @@ export class PlTreeResource implements PlTreeResourceI {
 
   /** Used for invalidation */
   markAllChanged() {
-    this.fields.forEach((field) => field.change.markChanged());
+    this.fieldsMap.forEach((field) => field.change.markChanged());
     this.finalChanged?.markChanged();
     this.resourceStateChange?.markChanged();
     this.lockedChange?.markChanged();
@@ -350,9 +352,6 @@ export class PlTreeResource implements PlTreeResourceI {
   }
 }
 
-// TODO implement invalidate tree
-// TODO make invalid state permanent
-// TODO invalidate on update errors
 export class PlTreeState {
   /** resource heap */
   private resources: Map<ResourceId, PlTreeResource> = new Map();
@@ -365,10 +364,10 @@ export class PlTreeState {
   constructor(
     /** This will be the only resource not deleted during GC round */
     public readonly root: ResourceId,
-    public readonly isFinalPredicate: FinalPredicate = (r) => false
+    public readonly isFinalPredicate: FinalResourceDataPredicate
   ) {}
 
-  public forEachResource(cb: (res: PlTreeResourceI) => void): void {
+  public forEachResource(cb: (res: ResourceDataWithFinalState) => void): void {
     this.resources.forEach((v) => cb(v));
   }
 
@@ -414,7 +413,7 @@ export class PlTreeState {
       if (resource !== undefined) {
         // updating existing resource
 
-        if (resource.final)
+        if (resource.finalState)
           unexpectedTransitionError('resource state can\t be updated after it is marked as final');
 
         let changed = false;
@@ -443,12 +442,20 @@ export class PlTreeState {
 
         // updating fields
         for (const fd of rd.fields) {
-          let field = resource.fields.get(fd.name);
+          let field = resource.fieldsMap.get(fd.name);
 
           if (!field) {
             // new field
 
-            field = new PlTreeField(fd.type, fd.value, fd.error, resource.version);
+            field = new PlTreeField(
+              fd.name,
+              fd.type,
+              fd.value,
+              fd.error,
+              fd.status,
+              fd.valueIsFinal,
+              resource.version
+            );
             if (isNotNullResourceId(fd.value)) incrementRefs.push(fd.value);
             if (isNotNullResourceId(fd.error)) incrementRefs.push(fd.error);
 
@@ -468,7 +475,7 @@ export class PlTreeState {
               notEmpty(resource.dynamicFieldListChanged).markChanged();
             }
 
-            resource.fields.set(fd.name, field);
+            resource.fieldsMap.set(fd.name, field);
 
             changed = true;
           } else {
@@ -516,12 +523,26 @@ export class PlTreeState {
               changed = true;
             }
 
+            // field status
+            if (field.status !== fd.status) {
+              field.status = fd.status;
+              field.change.markChanged();
+              changed = true;
+            }
+
+            // field valueIsFinal flag
+            if (field.valueIsFinal !== fd.valueIsFinal) {
+              field.valueIsFinal = fd.valueIsFinal;
+              field.change.markChanged();
+              changed = true;
+            }
+
             field.resourceVersion = resource.version;
           }
         }
 
         // detecting removed fields
-        resource.fields.forEach((field, fieldName, fields) => {
+        resource.fieldsMap.forEach((field, fieldName, fields) => {
           if (field.resourceVersion !== resource!.version) {
             if (field.type === 'Input' || field.type === 'Service' || field.type === 'Output')
               unexpectedTransitionError(`removal of ${field.type} field ${fieldName}`);
@@ -604,10 +625,18 @@ export class PlTreeState {
         resource.verifyReadyState();
         if (isNotNullResourceId(resource.error)) incrementRefs.push(resource.error);
         for (const fd of rd.fields) {
-          const field = new PlTreeField(fd.type, fd.value, fd.error, InitialResourceVersion);
+          const field = new PlTreeField(
+            fd.name,
+            fd.type,
+            fd.value,
+            fd.error,
+            fd.status,
+            fd.valueIsFinal,
+            InitialResourceVersion
+          );
           if (isNotNullResourceId(fd.value)) incrementRefs.push(fd.value);
           if (isNotNullResourceId(fd.error)) incrementRefs.push(fd.error);
-          resource.fields.set(fd.name, field);
+          resource.fieldsMap.set(fd.name, field);
         }
 
         // adding kv
@@ -647,7 +676,7 @@ export class PlTreeState {
         // garbage collection
         if (res.refCount === 0 && res.id !== this.root) {
           // removing fields
-          res.fields.forEach((field) => {
+          res.fieldsMap.forEach((field) => {
             if (isNotNullResourceId(field.value)) nextRefs.push(field.value);
             if (isNotNullResourceId(field.error)) nextRefs.push(field.error);
             field.change.markChanged();

package/src/sync.test.ts

@@ -1,5 +1,5 @@
 import { test, expect } from '@jest/globals';
-import { field, TestHelpers } from '@milaboratories/pl-client';
+import { DefaultFinalResourceDataPredicate, field, TestHelpers } from '@milaboratories/pl-client';
 import { PlTreeState } from './state';
 import { constructTreeLoadingRequest, loadTreeState } from './sync';
 import { Computable } from '@milaboratories/computable';
@@ -21,7 +21,7 @@ test('load resources', async () => {
       { sync: true }
     );
 
-    const treeState = new PlTreeState(r1);
+    const treeState = new PlTreeState(r1, DefaultFinalResourceDataPredicate);
 
     const theComputable = Computable.make((c) =>
       c.accessor(treeState.entry()).node().traverse('a', 'b')?.getDataAsString()

package/src/sync.ts

@@ -1,7 +1,6 @@
 import {
   FieldData,
   isNullResourceId,
-  NullResourceId,
   OptionalResourceId,
   PlTransaction,
   ResourceId
@@ -41,7 +40,7 @@ export function constructTreeLoadingRequest(
   const seedResources: ResourceId[] = [];
   const finalResources = new Set<ResourceId>();
   tree.forEachResource((res) => {
-    if (res.final) finalResources.add(res.id);
+    if (res.finalState) finalResources.add(res.id);
     else seedResources.push(res.id);
   });
 
@@ -53,13 +52,13 @@ export function constructTreeLoadingRequest(
 
 export type TreeLoadingStat = {
   requests: number;
-  roundtrips: number;
+  roundTrips: number;
   retrievedResources: number;
   retrievedFields: number;
   retrievedKeyValues: number;
   retrievedResourceDataBytes: number;
   retrievedKeyValueBytes: number;
-  prunnedFields: number;
+  prunedFields: number;
   finalResourcesSkipped: number;
   millisSpent: number;
 };
@@ -67,13 +66,13 @@ export type TreeLoadingStat = {
 export function initialTreeLoadingStat(): TreeLoadingStat {
   return {
     requests: 0,
-    roundtrips: 0,
+    roundTrips: 0,
     retrievedResources: 0,
     retrievedFields: 0,
     retrievedKeyValues: 0,
     retrievedResourceDataBytes: 0,
     retrievedKeyValueBytes: 0,
-    prunnedFields: 0,
+    prunedFields: 0,
     finalResourcesSkipped: 0,
     millisSpent: 0
   };
@@ -82,13 +81,13 @@ export function initialTreeLoadingStat(): TreeLoadingStat {
 export function formatTreeLoadingStat(stat: TreeLoadingStat): string {
   let result = `Requests: ${stat.requests}\n`;
   result += `Total time: ${msToHumanReadable(stat.millisSpent)}\n`;
-  result += `Roundtrips: ${stat.roundtrips}\n`;
+  result += `Round-trips: ${stat.roundTrips}\n`;
   result += `Resources: ${stat.retrievedResources}\n`;
   result += `Fields: ${stat.retrievedFields}\n`;
   result += `KV: ${stat.retrievedKeyValues}\n`;
   result += `Data Bytes: ${stat.retrievedResourceDataBytes}\n`;
   result += `KV Bytes: ${stat.retrievedKeyValueBytes}\n`;
-  result += `Pruned fields: ${stat.prunnedFields}\n`;
+  result += `Pruned fields: ${stat.prunedFields}\n`;
   result += `Final resources skipped: ${stat.finalResourcesSkipped}`;
   return result;
 }
@@ -104,7 +103,7 @@ export async function loadTreeState(
   // saving start timestamp to add time spent in this function to the stats at the end of the method
   const startTimestamp = Date.now();
 
-  // countind the request
+  // counting the request
   if (stats) stats.requests++;
 
   const { seedResources, finalResources, pruningFunction } = loadingRequest;
@@ -117,8 +116,8 @@ export async function loadTreeState(
   const pending = new Denque<Promise<ExtendedResourceData | undefined>>();
 
   // vars to calculate number of roundtrips for stats
-  let roundtripToggle: boolean = true;
-  let numberOfRoundtrips = 0;
+  let roundTripToggle: boolean = true;
+  let numberOfRoundTrips = 0;
 
   // tracking resources we already requested
   const requested = new Set<ResourceId>();
@@ -139,19 +138,19 @@ export async function loadTreeState(
     const resourceData = tx.getResourceDataIfExists(rid, true);
     const kvData = tx.listKeyValuesIfResourceExists(rid);
 
-    // counting roundrip (begin)
-    const addRT = roundtripToggle;
-    if (roundtripToggle) roundtripToggle = false;
+    // counting round-trip (begin)
+    const addRT = roundTripToggle;
+    if (roundTripToggle) roundTripToggle = false;
 
     // pushing combined promise
     pending.push(
       (async () => {
         const [resource, kv] = await Promise.all([resourceData, kvData]);
 
-        // counting roundrip, actually incrementing counter and returning toggle back, so the next request can acquire it
+        // counting round-trip, actually incrementing counter and returning toggle back, so the next request can acquire it
         if (addRT) {
-          numberOfRoundtrips++;
-          roundtripToggle = true;
+          numberOfRoundTrips++;
+          roundTripToggle = true;
         }
 
         if (resource === undefined) return undefined;
@@ -184,7 +183,7 @@ export async function loadTreeState(
       // apply field pruning, if requested
       const fieldsAfterPruning = pruningFunction(nextResource);
       // collecting stats
-      if (stats) stats.prunnedFields += nextResource.fields.length - fieldsAfterPruning.length;
+      if (stats) stats.prunedFields += nextResource.fields.length - fieldsAfterPruning.length;
       nextResource = { ...nextResource, fields: fieldsAfterPruning };
     }
 
@@ -211,7 +210,7 @@ export async function loadTreeState(
   // adding the time we spent in this method to stats
   if (stats) {
     stats.millisSpent += Date.now() - startTimestamp;
-    stats.roundtrips += numberOfRoundtrips;
+    stats.roundTrips += numberOfRoundTrips;
   }
 
   return result;