@milaboratories/pl-model-common 1.24.3 → 1.24.5

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@milaboratories/pl-model-common",
-  "version": "1.24.3",
+  "version": "1.24.5",
   "description": "Platforma SDK Model",
+  "files": [
+    "./dist/**/*",
+    "./src/**/*"
+  ],
   "type": "module",
-  "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -12,31 +16,28 @@
       "require": "./dist/index.cjs"
     }
   },
-  "files": [
-    "./dist/**/*",
-    "./src/**/*"
-  ],
   "dependencies": {
-    "zod": "~3.23.8",
     "canonicalize": "~2.1.0",
-    "@milaboratories/pl-error-like": "1.12.5"
+    "zod": "~3.23.8",
+    "@milaboratories/pl-error-like": "1.12.7"
   },
   "devDependencies": {
-    "eslint": "^9.25.1",
+    "@vitest/coverage-istanbul": "^4.0.16",
     "typescript": "~5.6.3",
     "vitest": "^4.0.16",
-    "@vitest/coverage-istanbul": "^4.0.16",
-    "@milaboratories/ts-builder": "1.2.4",
-    "@milaboratories/build-configs": "1.4.0",
-    "@milaboratories/ts-configs": "1.2.0",
-    "@milaboratories/eslint-config": "1.0.5"
+    "@milaboratories/build-configs": "1.4.2",
+    "@milaboratories/ts-configs": "1.2.1",
+    "@milaboratories/ts-builder": "1.2.6"
   },
   "scripts": {
-    "type-check": "ts-builder types --target node",
     "build": "ts-builder build --target node",
     "watch": "ts-builder build --target node --watch",
-    "lint": "eslint .",
+    "check": "ts-builder check --target node",
+    "formatter:check": "ts-builder formatter --check",
+    "linter:check": "ts-builder linter --check",
+    "types:check": "ts-builder type-check --target node",
     "test": "vitest run --coverage",
-    "do-pack": "rm -f *.tgz && pnpm pack && mv *.tgz package.tgz"
+    "do-pack": "rm -f *.tgz && pnpm pack && mv *.tgz package.tgz",
+    "fmt": "ts-builder format"
   }
 }

package/src/base32_encode.ts

@@ -7,7 +7,7 @@ function toDataView(data: Data) {
   if (data instanceof ArrayBuffer) return new DataView(data);
 
   throw new TypeError(
-    'Expected `data` to be an ArrayBuffer, Buffer, Int8Array, Uint8Array or Uint8ClampedArray',
+    "Expected `data` to be an ArrayBuffer, Buffer, Int8Array, Uint8Array or Uint8ClampedArray",
   );
 }
 
@@ -16,34 +16,34 @@ interface Options {
   padding?: boolean;
 }
 
-const RFC4648 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567';
-const RFC4648_HEX = '0123456789ABCDEFGHIJKLMNOPQRSTUV';
-const CROCKFORD = '0123456789ABCDEFGHJKMNPQRSTVWXYZ';
+const RFC4648 = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
+const RFC4648_HEX = "0123456789ABCDEFGHIJKLMNOPQRSTUV";
+const CROCKFORD = "0123456789ABCDEFGHJKMNPQRSTVWXYZ";
 
 export function base32Encode(
   data: Data,
-  variant: 'RFC3548' | 'RFC4648' | 'RFC4648-HEX' | 'Crockford',
+  variant: "RFC3548" | "RFC4648" | "RFC4648-HEX" | "Crockford",
   options?: Options,
 ) {
   options = options || {};
   let alphabet, defaultPadding;
 
   switch (variant) {
-    case 'RFC3548':
-    case 'RFC4648':
+    case "RFC3548":
+    case "RFC4648":
       alphabet = RFC4648;
       defaultPadding = true;
       break;
-    case 'RFC4648-HEX':
+    case "RFC4648-HEX":
       alphabet = RFC4648_HEX;
       defaultPadding = true;
       break;
-    case 'Crockford':
+    case "Crockford":
       alphabet = CROCKFORD;
       defaultPadding = false;
       break;
     default:
-      throw new Error('Unknown base32 variant: ' + String(variant));
+      throw new Error("Unknown base32 variant: " + String(variant));
   }
 
   const padding = options.padding !== undefined ? options.padding : defaultPadding;
@@ -51,7 +51,7 @@ export function base32Encode(
 
   let bits = 0;
   let value = 0;
-  let output = '';
+  let output = "";
 
   for (let i = 0; i < view.byteLength; i++) {
     value = (value << 8) | view.getUint8(i);
@@ -67,7 +67,7 @@ export function base32Encode(
 
   if (padding)
     while (output.length % 8 !== 0) {
-      output += '=';
+      output += "=";
     }
 
   return output;

package/src/base64.ts

@@ -1,15 +1,19 @@
-import type { WithImplicitCoercion } from 'node:buffer';
+import type { WithImplicitCoercion } from "node:buffer";
 
-export type Base64Compatible<T> = T extends WithImplicitCoercion<Uint8Array | readonly number[] | string> ? T : never;
+export type Base64Compatible<T> =
+  T extends WithImplicitCoercion<Uint8Array | readonly number[] | string> ? T : never;
 
-export type Base64Encoded<T = unknown> = Base64Compatible<T> extends never ? never : string & {
-  __base64_encoded: T;
-};
+export type Base64Encoded<T = unknown> =
+  Base64Compatible<T> extends never
+    ? never
+    : string & {
+        __base64_encoded: T;
+      };
 
 export function base64Encode<T>(value: Base64Compatible<T>): Base64Encoded<T> {
-  return Buffer.from(value).toString('base64') as Base64Encoded<T>;
+  return Buffer.from(value).toString("base64") as Base64Encoded<T>;
 }
 
 export function base64Decode<T extends string>(value: Base64Encoded<T>): T {
-  return Buffer.from(value, 'base64').toString() as T;
-};
+  return Buffer.from(value, "base64").toString() as T;
+}

package/src/block_state.ts

@@ -1,6 +1,6 @@
-import type { BlockOutputsBase } from './common_types';
-import type { NavigationState } from './navigation';
-import type { AuthorMarker } from './author_marker';
+import type { BlockOutputsBase } from "./common_types";
+import type { NavigationState } from "./navigation";
+import type { AuthorMarker } from "./author_marker";
 
 /**
  * @template Args    sets type of block arguments passed to the workflow

package/src/bmodel/block_config.ts

@@ -1,8 +1,8 @@
 // TODO BroadActiveHandleDescriptor must be removed
 
-import type { BlockCodeFeatureFlags } from '../flags';
-import type { BlockCodeWithInfo, Code } from './code';
-import type { BlockRenderingMode } from './types';
+import type { BlockCodeFeatureFlags } from "../flags";
+import type { BlockCodeWithInfo, Code } from "./code";
+import type { BlockRenderingMode } from "./types";
 
 /**
  * Descriptor for a state migration function.
@@ -23,7 +23,10 @@ export type BlockConfigV4Generic<
   _Data extends Record<string, unknown> = Record<string, unknown>,
   BroadActiveHandleDescriptor = unknown,
   NarrowActiveHandleDescriptor extends BroadActiveHandleDescriptor = BroadActiveHandleDescriptor,
-  Outputs extends Record<string, BroadActiveHandleDescriptor> = Record<string, BroadActiveHandleDescriptor>,
+  Outputs extends Record<string, BroadActiveHandleDescriptor> = Record<
+    string,
+    BroadActiveHandleDescriptor
+  >,
 > = {
   /** Discriminator to identify config version */
   readonly configVersion: 4;
@@ -93,7 +96,10 @@ export type BlockConfigV3Generic<
   UiState = unknown,
   BroadActiveHandleDescriptor = unknown,
   NarrowActiveHandleDescriptor extends BroadActiveHandleDescriptor = BroadActiveHandleDescriptor,
-  Outputs extends Record<string, BroadActiveHandleDescriptor> = Record<string, BroadActiveHandleDescriptor>,
+  Outputs extends Record<string, BroadActiveHandleDescriptor> = Record<
+    string,
+    BroadActiveHandleDescriptor
+  >,
 > = {
   /** Discriminator to identify config version */
   readonly configVersion: 3;
@@ -151,7 +157,7 @@ export type BlockConfigV3Generic<
 export type BlockConfigGeneric = BlockConfigV3Generic | BlockConfigV4Generic;
 
 export function extractCodeWithInfo(cfg: BlockConfigGeneric): BlockCodeWithInfo {
-  if (cfg.code === undefined) throw new Error('extractCodeWithInfo: No code bundle');
+  if (cfg.code === undefined) throw new Error("extractCodeWithInfo: No code bundle");
   return {
     code: cfg.code,
     sdkVersion: cfg.sdkVersion,

package/src/bmodel/code.ts

@@ -1,8 +1,8 @@
-import type { BlockCodeFeatureFlags } from '../flags';
-import { z } from 'zod';
+import type { BlockCodeFeatureFlags } from "../flags";
+import { z } from "zod";
 
 export const Code = z.object({
-  type: z.literal('plain'),
+  type: z.literal("plain"),
   content: z.string(),
 });
 

package/src/bmodel/container.ts

@@ -1,12 +1,12 @@
-import type { BlockConfigV3Generic, BlockConfigV4Generic } from './block_config';
-import type { Code } from './code';
-import type { BlockRenderingMode } from './types';
+import type { BlockConfigV3Generic, BlockConfigV4Generic } from "./block_config";
+import type { Code } from "./code";
+import type { BlockRenderingMode } from "./types";
 
 /** Container simplifying maintenance of forward and backward compatibility */
 export type BlockConfigContainer = {
-  readonly v4?: Omit<BlockConfigV4Generic, 'code'>;
+  readonly v4?: Omit<BlockConfigV4Generic, "code">;
   /** Actual config */
-  readonly v3?: Omit<BlockConfigV3Generic, 'code'>;
+  readonly v3?: Omit<BlockConfigV3Generic, "code">;
 
   /** Config code bundle. Actually is required, but we keep it optional for backward compatibility */
   readonly code?: Code;

package/src/bmodel/index.ts

@@ -1,5 +1,5 @@
-export * from './block_config';
-export * from './code';
-export * from './types';
-export * from './container';
-export * from './normalization';
+export * from "./block_config";
+export * from "./code";
+export * from "./types";
+export * from "./container";
+export * from "./normalization";

package/src/bmodel/normalization.ts

@@ -1,15 +1,11 @@
-import type { BlockConfigGeneric } from './block_config';
-import type { BlockConfigContainer } from './container';
+import type { BlockConfigGeneric } from "./block_config";
+import type { BlockConfigContainer } from "./container";
 
 function upgradeCfgOrLambda(data: unknown): unknown;
-function upgradeCfgOrLambda(
-  data: unknown | undefined
-): unknown | undefined;
-function upgradeCfgOrLambda(
-  data: unknown | undefined,
-): unknown | undefined {
+function upgradeCfgOrLambda(data: unknown | undefined): unknown | undefined;
+function upgradeCfgOrLambda(data: unknown | undefined): unknown | undefined {
   if (data === undefined) return undefined;
-  if (typeof data === 'string') return { __renderLambda: true, handle: data, retentive: false };
+  if (typeof data === "string") return { __renderLambda: true, handle: data, retentive: false };
   return data;
 }
 
@@ -22,7 +18,19 @@ function upgradeCfgOrLambda(
 export function extractConfigGeneric(cfg: BlockConfigContainer): BlockConfigGeneric {
   if (cfg.v4 !== undefined) {
     // version 4 (BlockModelV3) - inputsValid is derived from args() success/failure
-    const { args, prerunArgs, initialData, outputs, renderingMode, sdkVersion, featureFlags, sections, title, enrichmentTargets, migrations } = cfg.v4;
+    const {
+      args,
+      prerunArgs,
+      initialData,
+      outputs,
+      renderingMode,
+      sdkVersion,
+      featureFlags,
+      sections,
+      title,
+      enrichmentTargets,
+      migrations,
+    } = cfg.v4;
     const { code } = cfg;
     return {
       configVersion: 4,
@@ -79,15 +87,15 @@ export function extractConfigGeneric(cfg: BlockConfigContainer): BlockConfigGene
     const { sdkVersion, renderingMode, outputs, inputsValid, sections, initialArgs, code } = cfg;
     const fields = Object.keys(cfg);
     if (
-      sdkVersion === undefined
-      || renderingMode === undefined
-      || outputs === undefined
-      || inputsValid === undefined
-      || sections === undefined
-      || initialArgs === undefined
+      sdkVersion === undefined ||
+      renderingMode === undefined ||
+      outputs === undefined ||
+      inputsValid === undefined ||
+      sections === undefined ||
+      initialArgs === undefined
     )
       throw new Error(
-        `Malformed config v2. SDK version ${sdkVersion}; Fields = ${fields.join(', ')}`,
+        `Malformed config v2. SDK version ${sdkVersion}; Fields = ${fields.join(", ")}`,
       );
     return {
       configVersion: 3,
@@ -108,19 +116,19 @@ export function extractConfigGeneric(cfg: BlockConfigContainer): BlockConfigGene
     const { sdkVersion, canRun, renderingMode, outputs, sections, initialArgs, code } = cfg;
     const fields = Object.keys(cfg);
     if (
-      renderingMode === undefined
-      || outputs === undefined
-      || canRun === undefined
-      || sections === undefined
-      || initialArgs === undefined
+      renderingMode === undefined ||
+      outputs === undefined ||
+      canRun === undefined ||
+      sections === undefined ||
+      initialArgs === undefined
     )
       throw new Error(
-        `Malformed config v1. SDK version ${sdkVersion}; Fields = ${fields.join(', ')}`,
+        `Malformed config v1. SDK version ${sdkVersion}; Fields = ${fields.join(", ")}`,
       );
     return {
       configVersion: 3,
       modelAPIVersion: 1,
-      sdkVersion: sdkVersion ?? 'unknown',
+      sdkVersion: sdkVersion ?? "unknown",
       renderingMode,
       initialArgs,
       outputs: Object.fromEntries(
@@ -135,7 +143,7 @@ export function extractConfigGeneric(cfg: BlockConfigContainer): BlockConfigGene
     const { sdkVersion } = cfg;
     const fields = Object.keys(cfg);
     throw new Error(
-      `Config format not supported: SDK = ${sdkVersion}; Fields = ${fields.join(', ')}`,
+      `Config format not supported: SDK = ${sdkVersion}; Fields = ${fields.join(", ")}`,
     );
   }
 }

package/src/bmodel/types.ts

@@ -1 +1 @@
-export type BlockRenderingMode = 'Light' | 'Heavy' | 'DualContextHeavy';
+export type BlockRenderingMode = "Light" | "Heavy" | "DualContextHeavy";

package/src/branding.ts

@@ -1,3 +1,3 @@
-type Brand<B, K extends string = '__pl_model_brand__'> = { [key in K]: B };
+type Brand<B, K extends string = "__pl_model_brand__"> = { [key in K]: B };
 
-export type Branded<T, B, K extends string = '__pl_model_brand__'> = T & Brand<B, K>;
+export type Branded<T, B, K extends string = "__pl_model_brand__"> = T & Brand<B, K>;

package/src/common_types.ts

@@ -1,4 +1,4 @@
-import type { ErrorLike } from '@milaboratories/pl-error-like';
+import type { ErrorLike } from "@milaboratories/pl-error-like";
 
 /** Use this as constraint instead of `Function` */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/driver_kit.ts

@@ -1,4 +1,4 @@
-import type { BlobDriver, LogsDriver, LsDriver, PFrameDriver } from './drivers';
+import type { BlobDriver, LogsDriver, LsDriver, PFrameDriver } from "./drivers";
 
 /** Set of all drivers exposed in UI SDK via the platforma object. */
 export interface DriverKit {

package/src/drivers/ChunkedStreamReader.ts

@@ -1,4 +1,4 @@
-import type { RangeBytes } from './blob';
+import type { RangeBytes } from "./blob";
 
 /**
  * Status returned by onError handler to indicate what action to take
@@ -6,7 +6,7 @@ import type { RangeBytes } from './blob';
  * - 'error': Error the stream (calls controller.error, aborts ongoing fetches)
  * - 'cancel': Cancel the stream gracefully (calls controller.close, aborts ongoing fetches)
  */
-export type ErrorHandlerStatus = 'continue' | 'error' | 'cancel';
+export type ErrorHandlerStatus = "continue" | "error" | "cancel";
 
 /**
  * Options for creating a ChunkedStreamReader
@@ -60,17 +60,19 @@ export class ChunkedStreamReader {
     this.options = {
       ...options,
       chunkSize: options.chunkSize ?? 16 * 1024 * 1024,
-      onError: options.onError ?? (async () => {
-        // Default behavior: error (will automatically call controller.error)
-        return 'error';
-      }),
+      onError:
+        options.onError ??
+        (async () => {
+          // Default behavior: error (will automatically call controller.error)
+          return "error";
+        }),
     };
 
     if (this.totalSize < 0) {
-      throw new Error('Total size must be non-negative');
+      throw new Error("Total size must be non-negative");
     }
     if (this.chunkSize <= 0) {
-      throw new Error('Chunk size must be positive');
+      throw new Error("Chunk size must be positive");
     }
   }
 
@@ -175,20 +177,20 @@ export class ChunkedStreamReader {
       // If any error occurs during chunk reading, call the error handler
       const status = await this.onError(error);
 
-      if (status === 'error') {
+      if (status === "error") {
         this._errored = true;
         // Error the stream and abort any ongoing fetch operations
         controller.error(error);
-        this.abortController?.abort('Stream errored');
+        this.abortController?.abort("Stream errored");
         return true; // Stop reading
       }
 
-      if (status === 'cancel') {
+      if (status === "cancel") {
         this._canceled = true;
         // Close the stream gracefully and abort any ongoing fetch operations
         controller.close();
-        this.abortController?.abort('Stream cancelled');
-        console.debug('ChunkedStreamReader cancelled due to error');
+        this.abortController?.abort("Stream cancelled");
+        console.debug("ChunkedStreamReader cancelled due to error");
         return true; // Stop reading
       }
     }
@@ -236,7 +238,7 @@ export class ChunkedStreamReader {
         this._canceled = true;
         // Abort any ongoing fetch operations
         this.abortController?.abort(reason);
-        console.debug('ChunkedStreamReader cancelled:', reason);
+        console.debug("ChunkedStreamReader cancelled:", reason);
       },
     });
   }

package/src/drivers/blob.ts

@@ -1,19 +1,18 @@
-import type { Branded } from '../branding';
-import { z } from 'zod';
+import type { Branded } from "../branding";
+import { z } from "zod";
 
 /** Handle of locally downloaded blob. This handle is issued only after the
  * blob's content is downloaded locally, and ready for quick access. */
-export type LocalBlobHandle = Branded<string, 'LocalBlobHandle'>;
+export type LocalBlobHandle = Branded<string, "LocalBlobHandle">;
 
 /** Handle of remote blob. This handle is issued as soon as the data becomes
  * available on the remote server. */
-export type RemoteBlobHandle = Branded<string, 'RemoteBlobHandle'>;
+export type RemoteBlobHandle = Branded<string, "RemoteBlobHandle">;
 
 /** Being configured inside the output structure provides information about
  * blob's content and means to retrieve it when needed. */
 export interface BlobHandleAndSize<
-  H extends LocalBlobHandle | RemoteBlobHandle = | LocalBlobHandle
-  | RemoteBlobHandle,
+  H extends LocalBlobHandle | RemoteBlobHandle = LocalBlobHandle | RemoteBlobHandle,
 > {
   /** Handle to retrieve block content using {@link BlobDriver.getContent()} */
   readonly handle: H;
@@ -38,7 +37,7 @@ export function newRangeBytesOpt(from?: number, to?: number): RangeBytes | undef
   }
 
   const range = { from, to };
-  validateRangeBytes(range, 'newRangeBytesOpt');
+  validateRangeBytes(range, "newRangeBytesOpt");
 
   return range;
 }
@@ -76,8 +75,5 @@ export interface BlobDriver {
    * Depending on the handle type, content will be served from locally downloaded file,
    * or directly from remote platforma storage.
    */
-  getContent(
-    handle: LocalBlobHandle | RemoteBlobHandle,
-    range?: RangeBytes,
-  ): Promise<Uint8Array>;
+  getContent(handle: LocalBlobHandle | RemoteBlobHandle, range?: RangeBytes): Promise<Uint8Array>;
 }

package/src/drivers/index.ts

@@ -1,10 +1,10 @@
-export * from './interfaces';
+export * from "./interfaces";
 
-export * from './urls';
-export * from './blob';
-export * from './upload';
-export * from './log';
-export * from './ls';
+export * from "./urls";
+export * from "./blob";
+export * from "./upload";
+export * from "./log";
+export * from "./ls";
 
-export * from './pframe';
-export * from './ChunkedStreamReader';
+export * from "./pframe";
+export * from "./ChunkedStreamReader";

package/src/drivers/log.ts

@@ -12,7 +12,7 @@ export type ReadyLogHandle = `log+ready://log/${string}`;
 
 /** Type guard to check if log is live, and corresponding porcess is not finished. */
 export function isLiveLog(handle: AnyLogHandle | undefined): handle is LiveLogHandle {
-  return handle !== undefined && handle.startsWith('log+live://log/');
+  return handle !== undefined && handle.startsWith("log+live://log/");
 }
 
 /** Driver to retrieve logs given log handle */
@@ -32,7 +32,7 @@ export interface LogsDriver {
     /** Is substring for line search pattern.
      * This option makes controller to send to the client only lines, that
      * have given substring. */
-    searchStr?: string
+    searchStr?: string,
   ): Promise<StreamingApiResponse>;
 
   readText(
@@ -50,7 +50,7 @@ export interface LogsDriver {
     /** Is substring for line search pattern.
      * This option makes controller to send to the client only lines, that
      * have given substring. */
-    searchStr?: string
+    searchStr?: string,
   ): Promise<StreamingApiResponse>;
 }
 

package/src/drivers/ls.ts

@@ -1,17 +1,17 @@
-import { assertNever } from '../util';
-import type { Branded } from '../branding';
-import type { TableRange } from './pframe';
-import type { FileLike } from './interfaces';
+import { assertNever } from "../util";
+import type { Branded } from "../branding";
+import type { TableRange } from "./pframe";
+import type { FileLike } from "./interfaces";
 
-const uploadPrefix = 'upload://upload/';
-const indexPrefix = 'index://index/';
+const uploadPrefix = "upload://upload/";
+const indexPrefix = "index://index/";
 
 export type ImportFileHandleUpload = `upload://upload/${string}`;
 export type ImportFileHandleIndex = `index://index/${string}`;
 
 export type ImportFileHandle = ImportFileHandleUpload | ImportFileHandleIndex;
 
-export type LocalImportFileHandle = Branded<ImportFileHandle, 'Local'>;
+export type LocalImportFileHandle = Branded<ImportFileHandle, "Local">;
 
 export function isImportFileHandleUpload(
   handle: ImportFileHandle,
@@ -47,18 +47,18 @@ export type ListFilesResult = {
 
 export type LsEntry =
   | {
-    type: 'dir';
-    name: string;
-    fullPath: string;
-  }
+      type: "dir";
+      name: string;
+      fullPath: string;
+    }
   | {
-    type: 'file';
-    name: string;
-    fullPath: string;
+      type: "file";
+      name: string;
+      fullPath: string;
 
-    /** This handle should be set to args... */
-    handle: ImportFileHandle;
-  };
+      /** This handle should be set to args... */
+      handle: ImportFileHandle;
+    };
 
 export type OpenDialogFilter = {
   /** Human-readable file type name */
@@ -142,7 +142,7 @@ export function getFilePathFromHandle(handle: ImportFileHandle): string {
 }
 
 function extractFileName(filePath: string) {
-  return filePath.replace(/^.*[\\/]/, '');
+  return filePath.replace(/^.*[\\/]/, "");
 }
 
 /** Gets a file name from an import handle. */

package/src/drivers/pframe/column_filter.ts

@@ -1,4 +1,4 @@
-import type { ValueType } from './spec/spec';
+import type { ValueType } from "./spec/spec";
 
 /** Allows to search multiple columns in different contexts. */
 export interface ColumnFilter {