@platforma-sdk/model 1.40.6 → 1.41.0

package/dist/internal.d.ts

@@ -1,11 +1,12 @@
 import { ValueOrErrors } from '@milaboratories/pl-model-common';
-import { Platforma } from './platforma';
+import { Platforma, PlatformaApiVersion } from './platforma';
 import { FutureHandle, GlobalCfgRenderCtx } from './render/internal';
 /** Utility code helping to identify whether the code is running in actual UI environment */
 export declare function isInUI(): boolean;
 /** Utility code helping to retrieve a platforma instance form the environment */
 export declare function getPlatformaInstance<Args = unknown, Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>, UiState = unknown, Href extends `/${string}` = `/${string}`>(config?: {
     sdkVersion: string;
+    apiVersion: PlatformaApiVersion;
 }): Platforma<Args, Outputs, UiState, Href>;
 export declare function tryGetCfgRenderCtx(): GlobalCfgRenderCtx | undefined;
 export declare function getCfgRenderCtx(): GlobalCfgRenderCtx;

package/dist/internal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAErE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE1E,4FAA4F;AAC5F,wBAAgB,MAAM,YAIrB;AAED,iFAAiF;AACjF,wBAAgB,oBAAoB,CAClC,IAAI,GAAG,OAAO,EACd,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAC/F,OAAO,GAAG,OAAO,EACjB,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,EACxC,MAAM,CAAC,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAK1E;AAED,wBAAgB,kBAAkB,IAAI,kBAAkB,GAAG,SAAS,CAGnE;AAED,wBAAgB,eAAe,IAAI,kBAAkB,CAGpD;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,OAAO,CAM3F;AAID,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,QAU5F"}
+{"version":3,"file":"internal.d.ts","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAErE,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClE,OAAO,KAAK,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAE1E,4FAA4F;AAC5F,wBAAgB,MAAM,YAIrB;AAED,iFAAiF;AACjF,wBAAgB,oBAAoB,CAClC,IAAI,GAAG,OAAO,EACd,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAC/F,OAAO,GAAG,OAAO,EACjB,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,EACxC,MAAM,CAAC,EAAE;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,mBAAmB,CAAA;CAAE,GAAG,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAK3G;AAED,wBAAgB,kBAAkB,IAAI,kBAAkB,GAAG,SAAS,CAGnE;AAED,wBAAgB,eAAe,IAAI,kBAAkB,CAGpD;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,GAAG,OAAO,CAM3F;AAID,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,QAU5F"}

package/dist/platforma.d.ts

@@ -1,12 +1,22 @@
-import { BlockApi } from './block_api';
+import { BlockApiV1 } from './block_api_v1';
+import { BlockApiV2 } from './block_api_v2';
 import { BlockOutputsBase, BlockState, DriverKit, ValueOrErrors } from '@milaboratories/pl-model-common';
 import { SdkInfo } from './sdk_info';
 import { 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}`> extends BlockApi<Args, Outputs, UiState, Href>, DriverKit {
+/** Defines all methods to interact with the platform environment from within a block UI. @deprecated */
+export interface PlatformaV1<Args = unknown, Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>, UiState = unknown, Href extends `/${string}` = `/${string}`> extends BlockApiV1<Args, Outputs, UiState, Href>, DriverKit {
     /** Information about SDK version current platforma environment was compiled with. */
     readonly sdkInfo: SdkInfo;
+    readonly apiVersion?: 1;
 }
+/** V2 version based on effective json patches pulling API */
+export interface PlatformaV2<Args = unknown, Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>, UiState = unknown, Href extends `/${string}` = `/${string}`> extends BlockApiV2<Args, Outputs, UiState, Href>, DriverKit {
+    /** Information about SDK version current platforma environment was compiled with. */
+    readonly sdkInfo: SdkInfo;
+    readonly apiVersion: 2;
+}
+export type Platforma<Args = unknown, Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>, UiState = unknown, Href extends `/${string}` = `/${string}`> = PlatformaV1<Args, Outputs, UiState, Href> | PlatformaV2<Args, Outputs, UiState, Href>;
+export type PlatformaApiVersion = Platforma['apiVersion'];
 export type InferArgsType<Pl extends Platforma> = Pl extends Platforma<infer Args> ? Args : never;
 export type InferOutputsType<Pl extends Platforma> = Pl extends Platforma<unknown, infer Outputs> ? Outputs : never;
 export type InferUiState<Pl extends Platforma> = Pl extends Platforma<unknown, Record<string, ValueOrErrors<unknown>>, infer UiState> ? UiState : never;

package/dist/platforma.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"platforma.d.ts","sourceRoot":"","sources":["../src/platforma.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAC9G,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D,4FAA4F;AAC5F,MAAM,WAAW,SAAS,CACxB,IAAI,GAAG,OAAO,EACd,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAC/F,OAAO,GAAG,OAAO,EACjB,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,CACxC,SAAQ,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAC9C,SAAS;IACT,qFAAqF;IACrF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,MAAM,aAAa,CAAC,EAAE,SAAS,SAAS,IAAI,EAAE,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAElG,MAAM,MAAM,gBAAgB,CAAC,EAAE,SAAS,SAAS,IAC/C,EAAE,SAAS,SAAS,CAAC,OAAO,EAAE,MAAM,OAAO,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC;AAEjE,MAAM,MAAM,YAAY,CAAC,EAAE,SAAS,SAAS,IAC3C,EAAE,SAAS,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,OAAO,CAAC,GAChF,OAAO,GACP,KAAK,CAAC;AAEZ,MAAM,MAAM,aAAa,CAAC,EAAE,SAAS,SAAS,IAC5C,EAAE,SAAS,SAAS,CAAC,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEtF,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,KAAK,SAAS,CAAC;AAE7E,MAAM,MAAM,eAAe,CAAC,EAAE,SAAS,SAAS,IAAI,UAAU,CAC5D,aAAa,CAAC,EAAE,CAAC,EACjB,gBAAgB,CAAC,EAAE,CAAC,EACpB,YAAY,CAAC,EAAE,CAAC,EAChB,aAAa,CAAC,EAAE,CAAC,CAClB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,EAAE,SAAS,SAAS,IAAI,eAAe,CACtE,aAAa,CAAC,EAAE,CAAC,EACjB,gBAAgB,CAAC,EAAE,CAAC,EACpB,YAAY,CAAC,EAAE,CAAC,EAChB,aAAa,CAAC,EAAE,CAAC,CAClB,CAAC"}
+{"version":3,"file":"platforma.d.ts","sourceRoot":"","sources":["../src/platforma.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAC9G,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D,wGAAwG;AACxG,MAAM,WAAW,WAAW,CAC1B,IAAI,GAAG,OAAO,EACd,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAC/F,OAAO,GAAG,OAAO,EACjB,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,CACxC,SAAQ,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAChD,SAAS;IACT,qFAAqF;IACrF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;CACzB;AAED,6DAA6D;AAC7D,MAAM,WAAW,WAAW,CAC1B,IAAI,GAAG,OAAO,EACd,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAC/F,OAAO,GAAG,OAAO,EACjB,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,CACxC,SAAQ,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAChD,SAAS;IACT,qFAAqF;IACrF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;CACxB;AAED,MAAM,MAAM,SAAS,CACnB,IAAI,GAAG,OAAO,EACd,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAC/F,OAAO,GAAG,OAAO,EACjB,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,IACtC,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;AAE1F,MAAM,MAAM,mBAAmB,GAAG,SAAS,CAAC,YAAY,CAAC,CAAC;AAE1D,MAAM,MAAM,aAAa,CAAC,EAAE,SAAS,SAAS,IAAI,EAAE,SAAS,SAAS,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAElG,MAAM,MAAM,gBAAgB,CAAC,EAAE,SAAS,SAAS,IAC/C,EAAE,SAAS,SAAS,CAAC,OAAO,EAAE,MAAM,OAAO,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC;AAEjE,MAAM,MAAM,YAAY,CAAC,EAAE,SAAS,SAAS,IAC3C,EAAE,SAAS,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,OAAO,CAAC,GAChF,OAAO,GACP,KAAK,CAAC;AAEZ,MAAM,MAAM,aAAa,CAAC,EAAE,SAAS,SAAS,IAC5C,EAAE,SAAS,SAAS,CAAC,OAAO,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEtF,MAAM,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE;IAAE,UAAU,EAAE,MAAM,CAAA;CAAE,KAAK,SAAS,CAAC;AAE7E,MAAM,MAAM,eAAe,CAAC,EAAE,SAAS,SAAS,IAAI,UAAU,CAC5D,aAAa,CAAC,EAAE,CAAC,EACjB,gBAAgB,CAAC,EAAE,CAAC,EACpB,YAAY,CAAC,EAAE,CAAC,EAChB,aAAa,CAAC,EAAE,CAAC,CAClB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,EAAE,SAAS,SAAS,IAAI,eAAe,CACtE,aAAa,CAAC,EAAE,CAAC,EACjB,gBAAgB,CAAC,EAAE,CAAC,EACpB,YAAY,CAAC,EAAE,CAAC,EAChB,aAAa,CAAC,EAAE,CAAC,CAClB,CAAC"}

package/dist/raw_globals.d.ts

@@ -1,6 +1,6 @@
 import { ValueOrErrors } from '@milaboratories/pl-model-common';
-import { Platforma } from './platforma';
+import { Platforma, PlatformaApiVersion } from './platforma';
+export declare function getPlatformaApiVersion(): PlatformaApiVersion;
 export declare function getRawPlatformaInstance<Args = unknown, Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>, UiState = unknown, Href extends `/${string}` = `/${string}`>(): Platforma<Args, Outputs, UiState, Href>;
 /** Returns a global platforma instance or a provided fallback if it's not available. */
-export declare function getPlatformaOrDefault<Args = unknown, Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>, UiState = unknown, Href extends `/${string}` = `/${string}`>(platforma: Platforma<Args, Outputs, UiState, Href>): Platforma<Args, Outputs, UiState, Href>;
 //# sourceMappingURL=raw_globals.d.ts.map

package/dist/raw_globals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"raw_globals.d.ts","sourceRoot":"","sources":["../src/raw_globals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAGrE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAG7C,wBAAgB,uBAAuB,CACrC,IAAI,GAAG,OAAO,EACd,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAC/F,OAAO,GAAG,OAAO,EACjB,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,KACrC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAE3C;AAED,wFAAwF;AACxF,wBAAgB,qBAAqB,CACnC,IAAI,GAAG,OAAO,EACd,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAC/F,OAAO,GAAG,OAAO,EACjB,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,EACxC,SAAS,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAM7F"}
+{"version":3,"file":"raw_globals.d.ts","sourceRoot":"","sources":["../src/raw_globals.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAGrE,OAAO,KAAK,EAAE,SAAS,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAGlE,wBAAgB,sBAAsB,IAAI,mBAAmB,CAE5D;AAED,wBAAgB,uBAAuB,CACrC,IAAI,GAAG,OAAO,EACd,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,EAC/F,OAAO,GAAG,OAAO,EACjB,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE,KACrC,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAE3C;AAED,wFAAwF"}

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-export declare const PlatformaSDKVersion = "1.40.6";
+export declare const PlatformaSDKVersion = "1.41.0";
 //# sourceMappingURL=version.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platforma-sdk/model",
-  "version": "1.40.6",
+  "version": "1.41.0",
   "description": "Platforma.bio SDK / Block Model",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -22,7 +22,7 @@
     "utility-types": "^3.11.0",
     "canonicalize": "~2.1.0",
     "zod": "~3.23.8",
-    "@milaboratories/pl-model-common": "^1.16.5",
+    "@milaboratories/pl-model-common": "^1.17.0",
     "@milaboratories/pl-error-like": "^1.12.2"
   },
   "devDependencies": {
@@ -32,9 +32,10 @@
     "jest": "^29.7.0",
     "@jest/globals": "^29.7.0",
     "ts-jest": "^29.2.6",
+    "fast-json-patch": "^3.1.1",
+    "@milaboratories/helpers": "^1.6.18",
     "@platforma-sdk/eslint-config": "1.0.3",
-    "@milaboratories/build-configs": "1.0.4",
-    "@milaboratories/helpers": "^1.6.18"
+    "@milaboratories/build-configs": "1.0.4"
   },
   "scripts": {
     "type-check": "node ./scripts/save-package-version.cjs && tsc --noEmit --composite false",

package/src/{block_api.ts → block_api_v1.ts}

@@ -5,7 +5,7 @@ import type { BlockStatePatch } from './block_state_patch';
 export type CancelSubscription = () => void;
 
 /** Defines methods to read and write current block data. */
-export interface BlockApi<
+export interface BlockApiV1<
   Args = unknown,
   Outputs extends BlockOutputsBase = BlockOutputsBase,
   UiState = unknown,
@@ -69,7 +69,7 @@ export interface BlockApi<
   setBlockArgsAndUiState(args: Args, state: UiState): Promise<void>;
 
   /**
-   * Sets block navigatiopn state.
+   * Sets block navigation state.
    * */
   setNavigationState(state: NavigationState<Href>): Promise<void>;
 }

package/src/block_api_v2.ts

@@ -0,0 +1,69 @@
+import type {
+  BlockOutputsBase,
+  BlockState,
+  NavigationState,
+  ValueWithUTag,
+  ValueWithUTagAndAuthor,
+  AuthorMarker,
+  ResultOrError,
+} from '@milaboratories/pl-model-common';
+import type { Operation } from 'fast-json-patch';
+
+/** Defines methods to read and write current block data. */
+export interface BlockApiV2<
+  Args = unknown,
+  Outputs extends BlockOutputsBase = BlockOutputsBase,
+  UiState = unknown,
+  Href extends `/${string}` = `/${string}`,
+> {
+  /**
+   * Use this method to retrieve block state during UI initialization. Then use
+   * {@link onStateUpdates} method to subscribe for updates.
+   * */
+  loadBlockState(): Promise<ResultOrError<ValueWithUTag<BlockState<Args, Outputs, UiState, Href>>>>;
+
+  /**
+   * Get all json patches (rfc6902) that were applied to the block state.
+   * */
+  getPatches(uTag: string): Promise<ResultOrError<ValueWithUTagAndAuthor<Operation[]>>>;
+
+  /**
+   * Sets block args.
+   *
+   * This method returns when corresponding arguments are safely saved so in
+   * case the window is closed there will be no information losses. This
+   * function under the hood may delay actual persistence of the supplied
+   * arguments.
+   * */
+  setBlockArgs(args: Args, author?: AuthorMarker): Promise<ResultOrError<void>>;
+
+  /**
+   * Sets block ui state.
+   *
+   * This method returns when corresponding arguments are safely saved so in
+   * case the window is closed there will be no information losses. This
+   * function under the hood may delay actual persistence of the supplied
+   * values.
+   * */
+  setBlockUiState(state: UiState, author?: AuthorMarker): Promise<ResultOrError<void>>;
+
+  /**
+   * Sets block args and ui state.
+   *
+   * This method returns when corresponding arguments are safely saved so in
+   * case the window is closed there will be no information losses. This
+   * function under the hood may delay actual persistence of the supplied
+   * values.
+   * */
+  setBlockArgsAndUiState(args: Args, state: UiState, author?: AuthorMarker): Promise<ResultOrError<void>>;
+
+  /**
+   * Sets block navigation state.
+   * */
+  setNavigationState(state: NavigationState<Href>): Promise<ResultOrError<void>>;
+
+  /**
+   * Disposes the block API.
+   * */
+  dispose(): Promise<ResultOrError<void>>;
+}

package/src/builder.ts

@@ -2,7 +2,7 @@ import type { BlockRenderingMode, BlockSection, ValueOrErrors, AnyFunction, PlRe
 import type { Checked, ConfigResult, TypedConfig } from './config';
 import { getImmediate } from './config';
 import { getPlatformaInstance, isInUI, tryRegisterCallback } from './internal';
-import type { Platforma } from './platforma';
+import type { Platforma, PlatformaApiVersion, PlatformaV1, PlatformaV2 } from './platforma';
 import type { InferRenderFunctionReturn, RenderFunction } from './render';
 import { RenderCtx } from './render';
 import { PlatformaSDKVersion } from './version';
@@ -346,6 +346,21 @@ export class BlockModel<
     );
   }
 
+  /** Sets or overrides feature flags for the block. */
+  public withFeatureFlags(flags: Partial<BlockCodeKnownFeatureFlags>): BlockModel<Args, OutputsCfg, UiState, Href> {
+    return new BlockModel<Args, OutputsCfg, UiState, Href>(
+      this._renderingMode,
+      this._initialArgs,
+      this._initialUiState,
+      this._outputs,
+      this._inputsValid,
+      this._sections,
+      this._title,
+      this._enrichmentTargets,
+      { ...this._featureFlags, ...flags },
+    );
+  }
+
   /**
    * Defines how to derive list of upstream references this block is meant to enrich with its exports from block args.
    * Influences dependency graph construction.
@@ -367,10 +382,37 @@ export class BlockModel<
     );
   }
 
+  public done(apiVersion?: 1): PlatformaV1<
+    Args,
+    InferOutputsFromConfigs<Args, OutputsCfg, UiState>,
+    UiState,
+    Href
+  >;
+
+  public done(apiVersion: 2): PlatformaV2<
+    Args,
+    InferOutputsFromConfigs<Args, OutputsCfg, UiState>,
+    UiState,
+    Href
+  >;
+
   /** Renders all provided block settings into a pre-configured platforma API
    * instance, that can be used in frontend to interact with block state, and
    * other features provided by the platforma to the block. */
-  public done(): Platforma<
+  public done(apiVersion?: PlatformaApiVersion): Platforma<
+    Args,
+    InferOutputsFromConfigs<Args, OutputsCfg, UiState>,
+    UiState,
+    Href
+  > {
+    const requiresUIAPIVersion = apiVersion ?? 1;
+    return this.withFeatureFlags({
+      ...this._featureFlags,
+      requiresUIAPIVersion,
+    })._done(requiresUIAPIVersion);
+  }
+
+  public _done(apiVersion: PlatformaApiVersion): Platforma<
     Args,
     InferOutputsFromConfigs<Args, OutputsCfg, UiState>,
     UiState,
@@ -403,11 +445,13 @@ export class BlockModel<
       ),
     };
 
+    globalThis.platformaApiVersion = apiVersion;
+
     if (!isInUI())
-      // we are in the configuration rendering routine, not in actual UI
+    // we are in the configuration rendering routine, not in actual UI
       return { config } as any;
     // normal operation inside the UI
-    else return getPlatformaInstance({ sdkVersion: PlatformaSDKVersion }) as any;
+    else return getPlatformaInstance({ sdkVersion: PlatformaSDKVersion, apiVersion: platformaApiVersion }) as any;
   }
 }
 

package/src/global.d.ts

@@ -1,7 +1,10 @@
+import type { PlatformaApiVersion } from './platforma';
+
 declare global {
   /** Global factory method returning platforma instance */
-  var getPlatforma: PlatformaSDKVersion;
+  var getPlatforma: PlatformaSDKVersion; // TODO: invalid type
   var platforma: Platforma;
+  var platformaApiVersion: PlatformaApiVersion;
 
   function getEnvironmentValue(name: string): string | undefined;
 

package/src/index.ts

@@ -10,6 +10,8 @@ export * from './ref_util';
 export * from './render';
 export * from './sdk_info';
 export * from './raw_globals';
+export * from './block_api_v1';
+export * from './block_api_v2';
 
 // reexporting everything from SDK model
 export * from '@milaboratories/pl-model-common';

package/src/internal.ts

@@ -1,6 +1,6 @@
 import type { ValueOrErrors } from '@milaboratories/pl-model-common';
 import {} from './global';
-import type { Platforma } from './platforma';
+import type { Platforma, PlatformaApiVersion } from './platforma';
 import type { FutureHandle, GlobalCfgRenderCtx } from './render/internal';
 
 /** Utility code helping to identify whether the code is running in actual UI environment */
@@ -16,7 +16,7 @@ export function getPlatformaInstance<
   Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
   UiState = unknown,
   Href extends `/${string}` = `/${string}`,
->(config?: { sdkVersion: string }): Platforma<Args, Outputs, UiState, Href> {
+>(config?: { sdkVersion: string; apiVersion: PlatformaApiVersion }): Platforma<Args, Outputs, UiState, Href> {
   if (config && typeof globalThis.getPlatforma === 'function')
     return globalThis.getPlatforma(config);
   else if (typeof globalThis.platforma !== 'undefined') return globalThis.platforma;

package/src/platforma.ts

@@ -1,20 +1,44 @@
-import type { BlockApi } from './block_api';
+import type { BlockApiV1 } from './block_api_v1';
+import type { BlockApiV2 } from './block_api_v2';
 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<
+/** Defines all methods to interact with the platform environment from within a block UI. @deprecated */
+export interface PlatformaV1<
   Args = unknown,
   Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
   UiState = unknown,
   Href extends `/${string}` = `/${string}`,
-> extends BlockApi<Args, Outputs, UiState, Href>,
+> extends BlockApiV1<Args, Outputs, UiState, Href>,
   DriverKit {
   /** Information about SDK version current platforma environment was compiled with. */
   readonly sdkInfo: SdkInfo;
+  readonly apiVersion?: 1;
 }
 
+/** V2 version based on effective json patches pulling API */
+export interface PlatformaV2<
+  Args = unknown,
+  Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
+  UiState = unknown,
+  Href extends `/${string}` = `/${string}`,
+> extends BlockApiV2<Args, Outputs, UiState, Href>,
+  DriverKit {
+  /** Information about SDK version current platforma environment was compiled with. */
+  readonly sdkInfo: SdkInfo;
+  readonly apiVersion: 2;
+}
+
+export type Platforma<
+  Args = unknown,
+  Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
+  UiState = unknown,
+  Href extends `/${string}` = `/${string}`,
+> = PlatformaV1<Args, Outputs, UiState, Href> | PlatformaV2<Args, Outputs, UiState, Href>;
+
+export type PlatformaApiVersion = Platforma['apiVersion'];
+
 export type InferArgsType<Pl extends Platforma> = Pl extends Platforma<infer Args> ? Args : never;
 
 export type InferOutputsType<Pl extends Platforma> =

package/src/raw_globals.ts

@@ -1,28 +1,32 @@
 import type { ValueOrErrors } from '@milaboratories/pl-model-common';
 import {} from './global';
 import { getPlatformaInstance } from './internal';
-import type { Platforma } from './platforma';
+import type { Platforma, PlatformaApiVersion } from './platforma';
 import { PlatformaSDKVersion } from './version';
 
+export function getPlatformaApiVersion(): PlatformaApiVersion {
+  return platformaApiVersion ?? 1; // undefined means 1 for backward compatibility
+}
+
 export function getRawPlatformaInstance<
   Args = unknown,
   Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
   UiState = unknown,
   Href extends `/${string}` = `/${string}`,
 >(): Platforma<Args, Outputs, UiState, Href> {
-  return getPlatformaInstance<Args, Outputs, UiState, Href>({ sdkVersion: PlatformaSDKVersion });
+  return getPlatformaInstance<Args, Outputs, UiState, Href>({ sdkVersion: PlatformaSDKVersion, apiVersion: platformaApiVersion });
 }
 
 /** Returns a global platforma instance or a provided fallback if it's not available. */
-export function getPlatformaOrDefault<
-  Args = unknown,
-  Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
-  UiState = unknown,
-  Href extends `/${string}` = `/${string}`,
->(platforma: Platforma<Args, Outputs, UiState, Href>): Platforma<Args, Outputs, UiState, Href> {
-  try {
-    return getRawPlatformaInstance<Args, Outputs, UiState, Href>();
-  } catch {
-    return platforma;
-  }
-}
+// export function getPlatformaOrDefault<
+//   Args = unknown,
+//   Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
+//   UiState = unknown,
+//   Href extends `/${string}` = `/${string}`,
+// >(): PlatformaV1<Args, Outputs, UiState, Href> | PlatformaV2<Args, Outputs, UiState, Href> {
+//   try {
+//     return getRawPlatformaInstance<Args, Outputs, UiState, Href>();
+//   } catch {
+//     return platforma;
+//   }
+// }

package/dist/block_api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"block_api.d.ts","sourceRoot":"","sources":["../src/block_api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACrG,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAE3D,oFAAoF;AACpF,MAAM,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC;AAE5C,4DAA4D;AAC5D,MAAM,WAAW,QAAQ,CACvB,IAAI,GAAG,OAAO,EACd,OAAO,SAAS,gBAAgB,GAAG,gBAAgB,EACnD,OAAO,GAAG,OAAO,EACjB,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,IAAI,MAAM,EAAE;IAExC;;;SAGK;IACL,cAAc,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;IAEpE;;;;;;;;;;;;;;;;SAgBK;IACL,cAAc,CACZ,EAAE,EAAE,CAAC,OAAO,EAAE,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,GAC9E,kBAAkB,CAAC;IAEtB;;;;;;;SAOK;IACL,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC;;;;;;;SAOK;IACL,eAAe,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;SAOK;IACL,sBAAsB,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;SAEK;IACL,kBAAkB,CAAC,KAAK,EAAE,eAAe,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjE"}