@platforma-sdk/model 1.48.14 → 1.50.0

package/src/internal.ts

@@ -1,4 +1,4 @@
-import type { ValueOrErrors } from '@milaboratories/pl-model-common';
+import type { OutputWithStatus } from '@milaboratories/pl-model-common';
 import { } from './global';
 import type { Platforma, PlatformaApiVersion } from './platforma';
 import type { FutureHandle, GlobalCfgRenderCtx } from './render/internal';
@@ -13,7 +13,7 @@ export function isInUI() {
 /** Utility code helping to retrieve a platforma instance form the environment */
 export function getPlatformaInstance<
   Args = unknown,
-  Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
+  Outputs extends Record<string, OutputWithStatus<unknown>> = Record<string, OutputWithStatus<unknown>>,
   UiState = unknown,
   Href extends `/${string}` = `/${string}`,
 >(config?: { sdkVersion: string; apiVersion: PlatformaApiVersion }): Platforma<Args, Outputs, UiState, Href> {

package/src/platforma.ts

@@ -1,13 +1,13 @@
 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 { BlockOutputsBase, BlockState, DriverKit, OutputWithStatus } 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. @deprecated */
 export interface PlatformaV1<
   Args = unknown,
-  Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
+  Outputs extends Record<string, OutputWithStatus<unknown>> = Record<string, OutputWithStatus<unknown>>,
   UiState = unknown,
   Href extends `/${string}` = `/${string}`,
 > extends BlockApiV1<Args, Outputs, UiState, Href>,
@@ -20,7 +20,7 @@ export interface PlatformaV1<
 /** V2 version based on effective json patches pulling API */
 export interface PlatformaV2<
   Args = unknown,
-  Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
+  Outputs extends Record<string, OutputWithStatus<unknown>> = Record<string, OutputWithStatus<unknown>>,
   UiState = unknown,
   Href extends `/${string}` = `/${string}`,
 > extends BlockApiV2<Args, Outputs, UiState, Href>,
@@ -32,7 +32,7 @@ export interface PlatformaV2<
 
 export type Platforma<
   Args = unknown,
-  Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
+  Outputs extends Record<string, OutputWithStatus<unknown>> = Record<string, OutputWithStatus<unknown>>,
   UiState = unknown,
   Href extends `/${string}` = `/${string}`,
 > = PlatformaV1<Args, Outputs, UiState, Href> | PlatformaV2<Args, Outputs, UiState, Href>;
@@ -45,7 +45,7 @@ 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>
+  Pl extends Platforma<unknown, Record<string, OutputWithStatus<unknown>>, infer UiState>
     ? UiState
     : never;
 

package/src/raw_globals.ts

@@ -1,4 +1,4 @@
-import type { ValueOrErrors } from '@milaboratories/pl-model-common';
+import type { OutputWithStatus } from '@milaboratories/pl-model-common';
 import {} from './global';
 import { getPlatformaInstance } from './internal';
 import type { Platforma, PlatformaApiVersion } from './platforma';
@@ -10,7 +10,7 @@ export function getPlatformaApiVersion(): PlatformaApiVersion {
 
 export function getRawPlatformaInstance<
   Args = unknown,
-  Outputs extends Record<string, ValueOrErrors<unknown>> = Record<string, ValueOrErrors<unknown>>,
+  Outputs extends Record<string, OutputWithStatus<unknown>> = Record<string, OutputWithStatus<unknown>>,
   UiState = unknown,
   Href extends `/${string}` = `/${string}`,
 >(): Platforma<Args, Outputs, UiState, Href> {

package/src/typing.test.ts

@@ -1,8 +1,8 @@
 import {
   BlockSection,
   LocalBlobHandleAndSize,
-  RemoteBlobHandleAndSize,
-  ValueOrErrors
+  OutputWithStatus,
+  RemoteBlobHandleAndSize
 } from '@milaboratories/pl-model-common';
 import { expect, test } from 'vitest';
 import { DeriveHref, StdCtx } from './bconfig';
@@ -117,8 +117,8 @@ test('test config content', () => {
   assertType<
     InferOutputsType<typeof platforma>,
     {
-      cell1: ValueOrErrors<{ b: string[] }>;
-      cell2: ValueOrErrors<'v1'[]>;
+      cell1: OutputWithStatus<{ b: string[] }>;
+      cell2: OutputWithStatus<'v1'[]>;
     }
   >();
 
@@ -161,7 +161,7 @@ test('test config 2', () => {
   assertType<
     InferOutputsType<typeof platforma>,
     {
-      cell1: ValueOrErrors<{
+      cell1: OutputWithStatus<{
         b: string;
         c: [Uint8Array, 'asd'];
         d: string[];
@@ -169,8 +169,8 @@ test('test config 2', () => {
         f: LocalBlobHandleAndSize;
         g: RemoteBlobHandleAndSize;
       }>;
-      cell2: ValueOrErrors<number>;
-      cell3: ValueOrErrors<undefined>;
+      cell2: OutputWithStatus<number>;
+      cell3: OutputWithStatus<undefined>;
     }
   >();