@platforma-sdk/model 1.51.9 → 1.52.3

package/dist/block_model.cjs

@@ -0,0 +1,222 @@
+'use strict';
+
+var internal = require('./internal.cjs');
+var api = require('./render/api.cjs');
+require('@milaboratories/pl-model-common');
+require('./render/util/label.cjs');
+require('canonicalize');
+var version = require('./version.cjs');
+require('./block_storage_vm.cjs');
+var normalization = require('./bconfig/normalization.cjs');
+var types = require('./bconfig/types.cjs');
+
+/** Main entry point that each block should use in it's "config" module. Don't forget
+ * to call {@link done()} at the end of configuration. Value returned by this builder must be
+ * exported as constant with name "platforma" from the "config" module.
+ * API version is 3 (for UI) and 2 (for model) */
+class BlockModelV3 {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+    static INITIAL_BLOCK_FEATURE_FLAGS = {
+        supportsLazyState: true,
+        requiresUIAPIVersion: 3,
+        requiresModelAPIVersion: 2,
+    };
+    /**
+     * Creates a new BlockModelV3 builder with the specified data model and options.
+     *
+     * @example
+     * const dataModel = DataModel.create<BlockData>(() => ({ numbers: [], labels: [] }));
+     * BlockModelV3.create({ dataModel })
+     *   .args((data) => ({ numbers: data.numbers }))
+     *   .sections(() => [{ type: 'link', href: '/', label: 'Main' }])
+     *   .done();
+     *
+     * @param options Configuration options including required data model
+     */
+    static create(options) {
+        const { dataModel, renderingMode = 'Heavy' } = options;
+        // Register data model callbacks for VM use (initialData and upgrade)
+        dataModel.registerCallbacks();
+        return new BlockModelV3({
+            renderingMode,
+            dataModel,
+            outputs: {},
+            // Register default sections callback (returns empty array)
+            sections: internal.createAndRegisterRenderLambda({ handle: 'sections', lambda: () => [] }, true),
+            title: undefined,
+            subtitle: undefined,
+            tags: undefined,
+            enrichmentTargets: undefined,
+            featureFlags: { ...BlockModelV3.INITIAL_BLOCK_FEATURE_FLAGS },
+            args: undefined,
+            prerunArgs: undefined,
+        });
+    }
+    output(key, cfgOrRf, flags = {}) {
+        return new BlockModelV3({
+            ...this.config,
+            outputs: {
+                ...this.config.outputs,
+                [key]: internal.createAndRegisterRenderLambda({ handle: `output#${key}`, lambda: () => cfgOrRf(new api.RenderCtx()), ...flags }),
+            },
+        });
+    }
+    /** Shortcut for {@link output} with retentive flag set to true. */
+    retentiveOutput(key, rf) {
+        return this.output(key, rf, { retentive: true });
+    }
+    /** Shortcut for {@link output} with withStatus flag set to true. */
+    outputWithStatus(key, rf) {
+        return this.output(key, rf, { withStatus: true });
+    }
+    /**
+     * Sets a function to derive block args from data.
+     * This is called during setData to compute the args that will be used for block execution.
+     *
+     * @example
+     * .args<BlockArgs>((data) => ({ numbers: data.numbers }))
+     *
+     * @example
+     * .args<BlockArgs>((data) => {
+     *   if (data.numbers.length === 0) throw new Error('Numbers required'); // block not ready
+     *   return { numbers: data.numbers };
+     * })
+     */
+    args(lambda) {
+        return new BlockModelV3({
+            ...this.config,
+            args: internal.createAndRegisterRenderLambda({ handle: 'args', lambda }),
+        });
+    }
+    /**
+     * Sets a function to derive pre-run args from data (optional).
+     * This is called during setData to compute the args that will be used for staging/pre-run phase.
+     *
+     * If not defined, defaults to using the args() function result.
+     * If defined, uses its return value for the staging / prerun phase.
+     *
+     * The staging / prerun phase runs only if currentPrerunArgs differs from the executed
+     * version of prerunArgs (same comparison logic as currentArgs vs prodArgs).
+     *
+     * @example
+     * .prerunArgs((data) => ({ numbers: data.numbers }))
+     *
+     * @example
+     * .prerunArgs((data) => {
+     *   // Return undefined to skip staging for this block
+     *   if (!data.isReady) return undefined;
+     *   return { numbers: data.numbers };
+     * })
+     */
+    prerunArgs(fn) {
+        return new BlockModelV3({
+            ...this.config,
+            prerunArgs: internal.createAndRegisterRenderLambda({ handle: 'prerunArgs', lambda: fn }),
+        });
+    }
+    /** Sets the lambda to generate list of sections in the left block overviews panel. */
+    sections(rf) {
+        return new BlockModelV3({
+            ...this.config,
+            // Replace the default sections callback with the user-provided one
+            sections: internal.createAndRegisterRenderLambda({ handle: 'sections', lambda: () => rf(new api.RenderCtx()) }, true),
+        });
+    }
+    /** Sets a rendering function to derive block title, shown for the block in the left blocks-overview panel. */
+    title(rf) {
+        return new BlockModelV3({
+            ...this.config,
+            title: internal.createAndRegisterRenderLambda({ handle: 'title', lambda: () => rf(new api.RenderCtx()) }),
+        });
+    }
+    subtitle(rf) {
+        return new BlockModelV3({
+            ...this.config,
+            subtitle: internal.createAndRegisterRenderLambda({ handle: 'subtitle', lambda: () => rf(new api.RenderCtx()) }),
+        });
+    }
+    tags(rf) {
+        return new BlockModelV3({
+            ...this.config,
+            tags: internal.createAndRegisterRenderLambda({ handle: 'tags', lambda: () => rf(new api.RenderCtx()) }),
+        });
+    }
+    /** Sets or overrides feature flags for the block. */
+    withFeatureFlags(flags) {
+        return new BlockModelV3({
+            ...this.config,
+            featureFlags: { ...this.config.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.
+     */
+    enriches(lambda) {
+        return new BlockModelV3({
+            ...this.config,
+            enrichmentTargets: internal.createAndRegisterRenderLambda({ handle: 'enrichmentTargets', lambda: lambda }),
+        });
+    }
+    /** Renders all provided block settings into a pre-configured platforma API
+     * instance, that can be used in frontend to interact with block data, and
+     * other features provided by the platforma to the block. */
+    done() {
+        return this.withFeatureFlags({
+            ...this.config.featureFlags,
+        })._done();
+    }
+    _done() {
+        if (this.config.args === undefined)
+            throw new Error('Args rendering function not set.');
+        const apiVersion = 3;
+        const migrationCount = this.config.dataModel.migrationCount;
+        const blockConfig = {
+            v4: {
+                configVersion: 4,
+                modelAPIVersion: 2,
+                sdkVersion: version.PlatformaSDKVersion,
+                renderingMode: this.config.renderingMode,
+                args: this.config.args,
+                prerunArgs: this.config.prerunArgs,
+                // Reference to __pl_data_initial callback registered by DataModel
+                initialData: internal.createRenderLambda({ handle: '__pl_data_initial' }),
+                sections: this.config.sections,
+                title: this.config.title,
+                outputs: this.config.outputs,
+                enrichmentTargets: this.config.enrichmentTargets,
+                featureFlags: this.config.featureFlags,
+                // Generate migration descriptors (indices for metadata)
+                migrations: migrationCount > 0
+                    ? Array.from({ length: migrationCount }, (_, i) => ({ index: i }))
+                    : undefined,
+            },
+            // fields below are added to allow previous desktop versions read generated configs
+            sdkVersion: version.PlatformaSDKVersion,
+            renderingMode: this.config.renderingMode,
+            sections: this.config.sections,
+            outputs: Object.fromEntries(Object.entries(this.config.outputs).map(([key, value]) => [key, normalization.downgradeCfgOrLambda(value)])),
+        };
+        globalThis.platformaApiVersion = apiVersion;
+        if (!internal.isInUI())
+            // we are in the configuration rendering routine, not in actual UI
+            return { config: blockConfig };
+        // normal operation inside the UI
+        else
+            return {
+                ...internal.getPlatformaInstance({ sdkVersion: version.PlatformaSDKVersion, apiVersion }),
+                blockModelInfo: {
+                    outputs: Object.fromEntries(Object.entries(this.config.outputs)
+                        .map(([key, value]) => [key, {
+                            withStatus: Boolean(types.isConfigLambda(value) && value.withStatus),
+                        }])),
+                },
+            };
+    }
+}
+
+exports.BlockModelV3 = BlockModelV3;
+//# sourceMappingURL=block_model.cjs.map

package/dist/block_model.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"block_model.cjs","sources":["../src/block_model.ts"],"sourcesContent":["import type {\n  BlockRenderingMode,\n  BlockSection,\n  OutputWithStatus,\n  PlRef,\n  BlockCodeKnownFeatureFlags,\n  BlockConfigContainer,\n} from '@milaboratories/pl-model-common';\nimport { getPlatformaInstance, isInUI, createAndRegisterRenderLambda, createRenderLambda } from './internal';\nimport type { DataModel } from './block_migrations';\nimport type { PlatformaV3 } from './platforma';\nimport type { InferRenderFunctionReturn, RenderFunction } from './render';\nimport { RenderCtx } from './render';\nimport { PlatformaSDKVersion } from './version';\n// Import storage VM integration (side-effect: registers internal callbacks)\nimport './block_storage_vm';\nimport type {\n  ConfigRenderLambda,\n  DeriveHref,\n  ConfigRenderLambdaFlags,\n  InferOutputsFromLambdas,\n} from './bconfig';\nimport {\n  downgradeCfgOrLambda,\n  isConfigLambda,\n} from './bconfig';\nimport type { PlatformaExtended } from './platforma';\n\ntype SectionsExpectedType = readonly BlockSection[];\n\ntype NoOb = Record<string, never>;\n\ninterface BlockModelV3Config<\n  Args,\n  OutputsCfg extends Record<string, ConfigRenderLambda>,\n  Data,\n> {\n  renderingMode: BlockRenderingMode;\n  dataModel: DataModel<Data>;\n  outputs: OutputsCfg;\n  sections: ConfigRenderLambda;\n  title: ConfigRenderLambda | undefined;\n  subtitle: ConfigRenderLambda | undefined;\n  tags: ConfigRenderLambda | undefined;\n  enrichmentTargets: ConfigRenderLambda | undefined;\n  featureFlags: BlockCodeKnownFeatureFlags;\n  args: ConfigRenderLambda<Args> | undefined;\n  prerunArgs: ConfigRenderLambda<unknown> | undefined;\n}\n\n/** Options for creating a BlockModelV3 */\nexport interface BlockModelV3Options<Data extends Record<string, unknown>> {\n  /** The data model that defines initial data and migrations */\n  dataModel: DataModel<Data>;\n  /** Rendering mode for the block (default: 'Heavy') */\n  renderingMode?: BlockRenderingMode;\n}\n\n/** Main entry point that each block should use in it's \"config\" module. Don't forget\n * to call {@link done()} at the end of configuration. Value returned by this builder must be\n * exported as constant with name \"platforma\" from the \"config\" module.\n * API version is 3 (for UI) and 2 (for model) */\nexport class BlockModelV3<\n  Args,\n  OutputsCfg extends Record<string, ConfigRenderLambda>,\n  Data extends Record<string, unknown> = Record<string, unknown>,\n  Href extends `/${string}` = '/',\n> {\n  private constructor(\n    private readonly config: BlockModelV3Config<Args, OutputsCfg, Data>,\n  ) {}\n\n  public static readonly INITIAL_BLOCK_FEATURE_FLAGS: BlockCodeKnownFeatureFlags = {\n    supportsLazyState: true,\n    requiresUIAPIVersion: 3,\n    requiresModelAPIVersion: 2,\n  };\n\n  /**\n   * Creates a new BlockModelV3 builder with the specified data model and options.\n   *\n   * @example\n   * const dataModel = DataModel.create<BlockData>(() => ({ numbers: [], labels: [] }));\n   * BlockModelV3.create({ dataModel })\n   *   .args((data) => ({ numbers: data.numbers }))\n   *   .sections(() => [{ type: 'link', href: '/', label: 'Main' }])\n   *   .done();\n   *\n   * @param options Configuration options including required data model\n   */\n  public static create<Data extends Record<string, unknown>>(\n    options: BlockModelV3Options<Data>,\n  ): BlockModelV3<NoOb, {}, Data> {\n    const { dataModel, renderingMode = 'Heavy' } = options;\n\n    // Register data model callbacks for VM use (initialData and upgrade)\n    dataModel.registerCallbacks();\n\n    return new BlockModelV3<NoOb, {}, Data>({\n      renderingMode,\n      dataModel,\n      outputs: {},\n      // Register default sections callback (returns empty array)\n      sections: createAndRegisterRenderLambda({ handle: 'sections', lambda: () => [] }, true),\n      title: undefined,\n      subtitle: undefined,\n      tags: undefined,\n      enrichmentTargets: undefined,\n      featureFlags: { ...BlockModelV3.INITIAL_BLOCK_FEATURE_FLAGS },\n      args: undefined,\n      prerunArgs: undefined,\n    });\n  }\n\n  /**\n   * Add output cell wrapped with additional status information to the configuration\n   *\n   * @param key output cell name, that can be later used to retrieve the rendered value\n   * @param rf  callback calculating output value using context, that allows to access\n   *            workflows outputs and interact with platforma drivers\n   * @param flags additional flags that may alter lambda rendering procedure\n   * */\n  public output<const Key extends string, const RF extends RenderFunction<Args, Data>>(\n    key: Key,\n    rf: RF,\n    flags: ConfigRenderLambdaFlags & { withStatus: true }\n  ): BlockModelV3<\n    Args,\n      OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> & { withStatus: true } },\n      Data,\n      Href\n  >;\n  /**\n   * Add output cell to the configuration\n   *\n   * @param key output cell name, that can be later used to retrieve the rendered value\n   * @param rf  callback calculating output value using context, that allows to access\n   *            workflows outputs and interact with platforma drivers\n   * @param flags additional flags that may alter lambda rendering procedure\n   * */\n  public output<const Key extends string, const RF extends RenderFunction<Args, Data>>(\n    key: Key,\n    rf: RF,\n    flags?: ConfigRenderLambdaFlags\n  ): BlockModelV3<\n    Args,\n    OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> },\n    Data,\n    Href\n  >;\n  public output(\n    key: string,\n    cfgOrRf: RenderFunction<Args, Data>,\n    flags: ConfigRenderLambdaFlags = {},\n  ): BlockModelV3<Args, OutputsCfg, Data, Href> {\n    return new BlockModelV3({\n      ...this.config,\n      outputs: {\n        ...this.config.outputs,\n        [key]: createAndRegisterRenderLambda({ handle: `output#${key}`, lambda: () => cfgOrRf(new RenderCtx()), ...flags }),\n      },\n    });\n  }\n\n  /** Shortcut for {@link output} with retentive flag set to true. */\n  public retentiveOutput<const Key extends string, const RF extends RenderFunction<Args, Data>>(\n    key: Key,\n    rf: RF,\n  ): BlockModelV3<\n      Args,\n    OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> },\n    Data,\n    Href\n    > {\n    return this.output(key, rf, { retentive: true });\n  }\n\n  /** Shortcut for {@link output} with withStatus flag set to true. */\n  public outputWithStatus<const Key extends string, const RF extends RenderFunction<Args, Data>>(\n    key: Key,\n    rf: RF,\n  ) {\n    return this.output(key, rf, { withStatus: true });\n  }\n\n  /**\n   * Sets a function to derive block args from data.\n   * This is called during setData to compute the args that will be used for block execution.\n   *\n   * @example\n   * .args<BlockArgs>((data) => ({ numbers: data.numbers }))\n   *\n   * @example\n   * .args<BlockArgs>((data) => {\n   *   if (data.numbers.length === 0) throw new Error('Numbers required'); // block not ready\n   *   return { numbers: data.numbers };\n   * })\n   */\n  public args<Args>(lambda: (data: Data) => Args): BlockModelV3<Args, OutputsCfg, Data, Href> {\n    return new BlockModelV3<Args, OutputsCfg, Data, Href>({\n      ...this.config,\n      args: createAndRegisterRenderLambda<Args>({ handle: 'args', lambda }),\n    });\n  }\n\n  /**\n   * Sets a function to derive pre-run args from data (optional).\n   * This is called during setData to compute the args that will be used for staging/pre-run phase.\n   *\n   * If not defined, defaults to using the args() function result.\n   * If defined, uses its return value for the staging / prerun phase.\n   *\n   * The staging / prerun phase runs only if currentPrerunArgs differs from the executed\n   * version of prerunArgs (same comparison logic as currentArgs vs prodArgs).\n   *\n   * @example\n   * .prerunArgs((data) => ({ numbers: data.numbers }))\n   *\n   * @example\n   * .prerunArgs((data) => {\n   *   // Return undefined to skip staging for this block\n   *   if (!data.isReady) return undefined;\n   *   return { numbers: data.numbers };\n   * })\n   */\n  public prerunArgs(fn: (data: Data) => unknown): BlockModelV3<Args, OutputsCfg, Data, Href> {\n    return new BlockModelV3<Args, OutputsCfg, Data, Href>({\n      ...this.config,\n      prerunArgs: createAndRegisterRenderLambda({ handle: 'prerunArgs', lambda: fn }),\n    });\n  }\n\n  /** Sets the lambda to generate list of sections in the left block overviews panel. */\n  public sections<\n    const Ret extends SectionsExpectedType,\n    const RF extends RenderFunction<Args, Data, Ret>,\n  >(rf: RF): BlockModelV3<Args, OutputsCfg, Data, DeriveHref<ReturnType<RF>>> {\n    return new BlockModelV3<Args, OutputsCfg, Data, DeriveHref<ReturnType<RF>>>({\n      ...this.config,\n      // Replace the default sections callback with the user-provided one\n      sections: createAndRegisterRenderLambda({ handle: 'sections', lambda: () => rf(new RenderCtx()) }, true),\n    });\n  }\n\n  /** Sets a rendering function to derive block title, shown for the block in the left blocks-overview panel. */\n  public title(\n    rf: RenderFunction<Args, Data, string>,\n  ): BlockModelV3<Args, OutputsCfg, Data, Href> {\n    return new BlockModelV3<Args, OutputsCfg, Data, Href>({\n      ...this.config,\n      title: createAndRegisterRenderLambda({ handle: 'title', lambda: () => rf(new RenderCtx()) }),\n    });\n  }\n\n  public subtitle(\n    rf: RenderFunction<Args, Data, string>,\n  ): BlockModelV3<Args, OutputsCfg, Data, Href> {\n    return new BlockModelV3<Args, OutputsCfg, Data, Href>({\n      ...this.config,\n      subtitle: createAndRegisterRenderLambda({ handle: 'subtitle', lambda: () => rf(new RenderCtx()) }),\n    });\n  }\n\n  public tags(\n    rf: RenderFunction<Args, Data, string[]>,\n  ): BlockModelV3<Args, OutputsCfg, Data, Href> {\n    return new BlockModelV3<Args, OutputsCfg, Data, Href>({\n      ...this.config,\n      tags: createAndRegisterRenderLambda({ handle: 'tags', lambda: () => rf(new RenderCtx()) }),\n    });\n  }\n\n  /** Sets or overrides feature flags for the block. */\n  public withFeatureFlags(flags: Partial<BlockCodeKnownFeatureFlags>): BlockModelV3<Args, OutputsCfg, Data, Href> {\n    return new BlockModelV3<Args, OutputsCfg, Data, Href>({\n      ...this.config,\n      featureFlags: { ...this.config.featureFlags, ...flags },\n    });\n  }\n\n  /**\n   * Defines how to derive list of upstream references this block is meant to enrich with its exports from block args.\n   * Influences dependency graph construction.\n   */\n  public enriches(\n    lambda: (args: Args) => PlRef[],\n  ): BlockModelV3<Args, OutputsCfg, Data, Href> {\n    return new BlockModelV3<Args, OutputsCfg, Data, Href>({\n      ...this.config,\n      enrichmentTargets: createAndRegisterRenderLambda({ handle: 'enrichmentTargets', lambda: lambda }),\n    });\n  }\n\n  /** Renders all provided block settings into a pre-configured platforma API\n   * instance, that can be used in frontend to interact with block data, and\n   * other features provided by the platforma to the block. */\n  public done(): PlatformaExtended<PlatformaV3<\n    Args,\n    InferOutputsFromLambdas<OutputsCfg>,\n    Data,\n    Href\n  >> {\n    return this.withFeatureFlags({\n      ...this.config.featureFlags,\n    })._done();\n  }\n\n  public _done(): PlatformaExtended<PlatformaV3<\n    Args,\n    InferOutputsFromLambdas<OutputsCfg>,\n    Data,\n    Href\n  >> {\n    if (this.config.args === undefined) throw new Error('Args rendering function not set.');\n\n    const apiVersion = 3;\n\n    const migrationCount = this.config.dataModel.migrationCount;\n\n    const blockConfig: BlockConfigContainer = {\n      v4: {\n        configVersion: 4,\n        modelAPIVersion: 2,\n        sdkVersion: PlatformaSDKVersion,\n        renderingMode: this.config.renderingMode,\n        args: this.config.args,\n        prerunArgs: this.config.prerunArgs,\n        // Reference to __pl_data_initial callback registered by DataModel\n        initialData: createRenderLambda({ handle: '__pl_data_initial' }),\n        sections: this.config.sections,\n        title: this.config.title,\n        outputs: this.config.outputs,\n        enrichmentTargets: this.config.enrichmentTargets,\n        featureFlags: this.config.featureFlags,\n        // Generate migration descriptors (indices for metadata)\n        migrations: migrationCount > 0\n          ? Array.from({ length: migrationCount }, (_, i) => ({ index: i }))\n          : undefined,\n      },\n\n      // fields below are added to allow previous desktop versions read generated configs\n      sdkVersion: PlatformaSDKVersion,\n      renderingMode: this.config.renderingMode,\n      sections: this.config.sections,\n      outputs: Object.fromEntries(\n        Object.entries(this.config.outputs).map(([key, value]) => [key, downgradeCfgOrLambda(value)]),\n      ),\n    };\n\n    globalThis.platformaApiVersion = apiVersion;\n\n    if (!isInUI())\n    // we are in the configuration rendering routine, not in actual UI\n      return { config: blockConfig } as any;\n    // normal operation inside the UI\n    else return {\n      ...getPlatformaInstance({ sdkVersion: PlatformaSDKVersion, apiVersion }),\n      blockModelInfo: {\n        outputs: Object.fromEntries(\n          Object.entries(this.config.outputs)\n            .map(([key, value]) => [key, {\n              withStatus: Boolean(isConfigLambda(value) && value.withStatus),\n            }]),\n        ),\n      },\n    } as any;\n  }\n}\n\n// Type tests for BlockModelV3\n\nexport type Expect<T extends true> = T;\n\nexport type Equal<X, Y> =\n  (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;\n\nexport type Merge<A, B> = {\n  [K in keyof A | keyof B]: K extends keyof B ? B[K] : K extends keyof A ? A[K] : never;\n};\n\n// Helper types for testing\ntype _TestArgs = { inputFile: string; threshold: number };\ntype _TestData = { selectedTab: string };\ntype _TestOutputs = { result: ConfigRenderLambda<string>; count: ConfigRenderLambda<number> };\n\n// Test: Merge type works correctly\ntype _MergeTest1 = Expect<Equal<Merge<{ a: 1 }, { b: 2 }>, { a: 1; b: 2 }>>;\ntype _MergeTest2 = Expect<Equal<Merge<{ a: 1 }, { a: 2 }>, { a: 2 }>>;\ntype _MergeTest3 = Expect<Equal<Merge<{ a: 1; b: 1 }, { b: 2; c: 3 }>, { a: 1; b: 2; c: 3 }>>;\n\n// Test: create() returns a BlockModelV3 instance\n// Note: Due to function overloads, ReturnType uses the last overload signature.\n// We verify the structure is correct using a simpler assignability test.\ntype _CreateResult = ReturnType<typeof BlockModelV3.create>;\ntype _CreateIsBlockModelV3 = _CreateResult extends BlockModelV3<infer _A, infer _O, infer _S> ? true : false;\ntype _CreateTest = Expect<_CreateIsBlockModelV3>;\n\n// Test: BlockModelV3Config interface structure\ntype _ConfigTest = Expect<Equal<\n  BlockModelV3Config<_TestArgs, _TestOutputs, _TestData>,\n  {\n    renderingMode: BlockRenderingMode;\n    args: ConfigRenderLambda<_TestArgs> | undefined;\n    prerunArgs: ConfigRenderLambda<unknown> | undefined;\n    dataModel: DataModel<_TestData>;\n    outputs: _TestOutputs;\n    sections: ConfigRenderLambda;\n    title: ConfigRenderLambda | undefined;\n    subtitle: ConfigRenderLambda | undefined;\n    tags: ConfigRenderLambda | undefined;\n    enrichmentTargets: ConfigRenderLambda | undefined;\n    featureFlags: BlockCodeKnownFeatureFlags;\n  }\n>>;\n\n// Test: Default Href is '/'\ntype _HrefDefaultTest = BlockModelV3<_TestArgs, {}, _TestData> extends BlockModelV3<_TestArgs, {}, _TestData, '/'> ? true : false;\ntype _VerifyHrefDefault = Expect<_HrefDefaultTest>;\n\n// Test: Custom Href can be specified\ntype _CustomHref = '/settings' | '/main';\ntype _HrefCustomBuilder = BlockModelV3<_TestArgs, {}, _TestData, _CustomHref>;\ntype _HrefCustomTest = _HrefCustomBuilder extends BlockModelV3<_TestArgs, {}, _TestData, _CustomHref> ? true : false;\ntype _VerifyHrefCustom = Expect<_HrefCustomTest>;\n\n// Test: Output type accumulation with & intersection\ntype _OutputsAccumulation = { a: ConfigRenderLambda<string> } & { b: ConfigRenderLambda<number> };\ntype _VerifyOutputsHaveKeys = Expect<Equal<keyof _OutputsAccumulation, 'a' | 'b'>>;\n\n// Test: Builder with all type parameters specified compiles\ntype _FullBuilder = BlockModelV3<_TestArgs, _TestOutputs, _TestData, '/main'>;\ntype _FullBuilderTest = _FullBuilder extends BlockModelV3<_TestArgs, _TestOutputs, _TestData, '/main'> ? true : false;\ntype _VerifyFullBuilder = Expect<_FullBuilderTest>;\n\n// Test: InferOutputsFromLambdas maps outputs correctly\ntype _InferOutputsTest = InferOutputsFromLambdas<{ myOutput: ConfigRenderLambda<number> }>;\ntype _VerifyInferOutputs = Expect<Equal<\n  _InferOutputsTest,\n  { myOutput: OutputWithStatus<number> & { __unwrap: true } }\n>>;\n"],"names":["createAndRegisterRenderLambda","RenderCtx","PlatformaSDKVersion","createRenderLambda","downgradeCfgOrLambda","isInUI","getPlatformaInstance","isConfigLambda"],"mappings":";;;;;;;;;;;;AA0DA;;;AAGiD;MACpC,YAAY,CAAA;AAOJ,IAAA,MAAA;AADnB,IAAA,WAAA,CACmB,MAAkD,EAAA;QAAlD,IAAA,CAAA,MAAM,GAAN,MAAM;IACtB;IAEI,OAAgB,2BAA2B,GAA+B;AAC/E,QAAA,iBAAiB,EAAE,IAAI;AACvB,QAAA,oBAAoB,EAAE,CAAC;AACvB,QAAA,uBAAuB,EAAE,CAAC;KAC3B;AAED;;;;;;;;;;;AAWG;IACI,OAAO,MAAM,CAClB,OAAkC,EAAA;QAElC,MAAM,EAAE,SAAS,EAAE,aAAa,GAAG,OAAO,EAAE,GAAG,OAAO;;QAGtD,SAAS,CAAC,iBAAiB,EAAE;QAE7B,OAAO,IAAI,YAAY,CAAiB;YACtC,aAAa;YACb,SAAS;AACT,YAAA,OAAO,EAAE,EAAE;;AAEX,YAAA,QAAQ,EAAEA,sCAA6B,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,CAAC;AACvF,YAAA,KAAK,EAAE,SAAS;AAChB,YAAA,QAAQ,EAAE,SAAS;AACnB,YAAA,IAAI,EAAE,SAAS;AACf,YAAA,iBAAiB,EAAE,SAAS;AAC5B,YAAA,YAAY,EAAE,EAAE,GAAG,YAAY,CAAC,2BAA2B,EAAE;AAC7D,YAAA,IAAI,EAAE,SAAS;AACf,YAAA,UAAU,EAAE,SAAS;AACtB,SAAA,CAAC;IACJ;AAsCO,IAAA,MAAM,CACX,GAAW,EACX,OAAmC,EACnC,QAAiC,EAAE,EAAA;QAEnC,OAAO,IAAI,YAAY,CAAC;YACtB,GAAG,IAAI,CAAC,MAAM;AACd,YAAA,OAAO,EAAE;AACP,gBAAA,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;gBACtB,CAAC,GAAG,GAAGA,sCAA6B,CAAC,EAAE,MAAM,EAAE,CAAA,OAAA,EAAU,GAAG,CAAA,CAAE,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC,IAAIC,aAAS,EAAE,CAAC,EAAE,GAAG,KAAK,EAAE,CAAC;AACpH,aAAA;AACF,SAAA,CAAC;IACJ;;IAGO,eAAe,CACpB,GAAQ,EACR,EAAM,EAAA;AAON,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;IAClD;;IAGO,gBAAgB,CACrB,GAAQ,EACR,EAAM,EAAA;AAEN,QAAA,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;IACnD;AAEA;;;;;;;;;;;;AAYG;AACI,IAAA,IAAI,CAAO,MAA4B,EAAA;QAC5C,OAAO,IAAI,YAAY,CAA+B;YACpD,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAED,sCAA6B,CAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AACtE,SAAA,CAAC;IACJ;AAEA;;;;;;;;;;;;;;;;;;;AAmBG;AACI,IAAA,UAAU,CAAC,EAA2B,EAAA;QAC3C,OAAO,IAAI,YAAY,CAA+B;YACpD,GAAG,IAAI,CAAC,MAAM;AACd,YAAA,UAAU,EAAEA,sCAA6B,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;AAChF,SAAA,CAAC;IACJ;;AAGO,IAAA,QAAQ,CAGb,EAAM,EAAA;QACN,OAAO,IAAI,YAAY,CAAqD;YAC1E,GAAG,IAAI,CAAC,MAAM;;YAEd,QAAQ,EAAEA,sCAA6B,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,IAAIC,aAAS,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC;AACzG,SAAA,CAAC;IACJ;;AAGO,IAAA,KAAK,CACV,EAAsC,EAAA;QAEtC,OAAO,IAAI,YAAY,CAA+B;YACpD,GAAG,IAAI,CAAC,MAAM;YACd,KAAK,EAAED,sCAA6B,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,IAAIC,aAAS,EAAE,CAAC,EAAE,CAAC;AAC7F,SAAA,CAAC;IACJ;AAEO,IAAA,QAAQ,CACb,EAAsC,EAAA;QAEtC,OAAO,IAAI,YAAY,CAA+B;YACpD,GAAG,IAAI,CAAC,MAAM;YACd,QAAQ,EAAED,sCAA6B,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,IAAIC,aAAS,EAAE,CAAC,EAAE,CAAC;AACnG,SAAA,CAAC;IACJ;AAEO,IAAA,IAAI,CACT,EAAwC,EAAA;QAExC,OAAO,IAAI,YAAY,CAA+B;YACpD,GAAG,IAAI,CAAC,MAAM;YACd,IAAI,EAAED,sCAA6B,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,IAAIC,aAAS,EAAE,CAAC,EAAE,CAAC;AAC3F,SAAA,CAAC;IACJ;;AAGO,IAAA,gBAAgB,CAAC,KAA0C,EAAA;QAChE,OAAO,IAAI,YAAY,CAA+B;YACpD,GAAG,IAAI,CAAC,MAAM;YACd,YAAY,EAAE,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,KAAK,EAAE;AACxD,SAAA,CAAC;IACJ;AAEA;;;AAGG;AACI,IAAA,QAAQ,CACb,MAA+B,EAAA;QAE/B,OAAO,IAAI,YAAY,CAA+B;YACpD,GAAG,IAAI,CAAC,MAAM;AACd,YAAA,iBAAiB,EAAED,sCAA6B,CAAC,EAAE,MAAM,EAAE,mBAAmB,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AAClG,SAAA,CAAC;IACJ;AAEA;;AAE4D;IACrD,IAAI,GAAA;QAMT,OAAO,IAAI,CAAC,gBAAgB,CAAC;AAC3B,YAAA,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY;SAC5B,CAAC,CAAC,KAAK,EAAE;IACZ;IAEO,KAAK,GAAA;AAMV,QAAA,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC;QAEvF,MAAM,UAAU,GAAG,CAAC;QAEpB,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc;AAE3D,QAAA,MAAM,WAAW,GAAyB;AACxC,YAAA,EAAE,EAAE;AACF,gBAAA,aAAa,EAAE,CAAC;AAChB,gBAAA,eAAe,EAAE,CAAC;AAClB,gBAAA,UAAU,EAAEE,2BAAmB;AAC/B,gBAAA,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;AACxC,gBAAA,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;AACtB,gBAAA,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;;gBAElC,WAAW,EAAEC,2BAAkB,CAAC,EAAE,MAAM,EAAE,mBAAmB,EAAE,CAAC;AAChE,gBAAA,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;AAC9B,gBAAA,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK;AACxB,gBAAA,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO;AAC5B,gBAAA,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,iBAAiB;AAChD,gBAAA,YAAY,EAAE,IAAI,CAAC,MAAM,CAAC,YAAY;;gBAEtC,UAAU,EAAE,cAAc,GAAG;sBACzB,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;AACjE,sBAAE,SAAS;AACd,aAAA;;AAGD,YAAA,UAAU,EAAED,2BAAmB;AAC/B,YAAA,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,aAAa;AACxC,YAAA,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ;AAC9B,YAAA,OAAO,EAAE,MAAM,CAAC,WAAW,CACzB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAEE,kCAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAC9F;SACF;AAED,QAAA,UAAU,CAAC,mBAAmB,GAAG,UAAU;QAE3C,IAAI,CAACC,eAAM,EAAE;;AAEX,YAAA,OAAO,EAAE,MAAM,EAAE,WAAW,EAAS;;;YAElC,OAAO;gBACV,GAAGC,6BAAoB,CAAC,EAAE,UAAU,EAAEJ,2BAAmB,EAAE,UAAU,EAAE,CAAC;AACxE,gBAAA,cAAc,EAAE;AACd,oBAAA,OAAO,EAAE,MAAM,CAAC,WAAW,CACzB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO;AAC/B,yBAAA,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAE;4BAC3B,UAAU,EAAE,OAAO,CAACK,oBAAc,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC;AAC/D,yBAAA,CAAC,CAAC,CACN;AACF,iBAAA;aACK;IACV;;;;;"}

package/dist/block_model.d.ts

@@ -0,0 +1,132 @@
+import type { BlockRenderingMode, BlockSection, PlRef, BlockCodeKnownFeatureFlags } from '@milaboratories/pl-model-common';
+import type { DataModel } from './block_migrations';
+import type { PlatformaV3 } from './platforma';
+import type { InferRenderFunctionReturn, RenderFunction } from './render';
+import './block_storage_vm';
+import type { ConfigRenderLambda, DeriveHref, ConfigRenderLambdaFlags, InferOutputsFromLambdas } from './bconfig';
+import type { PlatformaExtended } from './platforma';
+type SectionsExpectedType = readonly BlockSection[];
+type NoOb = Record<string, never>;
+/** Options for creating a BlockModelV3 */
+export interface BlockModelV3Options<Data extends Record<string, unknown>> {
+    /** The data model that defines initial data and migrations */
+    dataModel: DataModel<Data>;
+    /** Rendering mode for the block (default: 'Heavy') */
+    renderingMode?: BlockRenderingMode;
+}
+/** Main entry point that each block should use in it's "config" module. Don't forget
+ * to call {@link done()} at the end of configuration. Value returned by this builder must be
+ * exported as constant with name "platforma" from the "config" module.
+ * API version is 3 (for UI) and 2 (for model) */
+export declare class BlockModelV3<Args, OutputsCfg extends Record<string, ConfigRenderLambda>, Data extends Record<string, unknown> = Record<string, unknown>, Href extends `/${string}` = '/'> {
+    private readonly config;
+    private constructor();
+    static readonly INITIAL_BLOCK_FEATURE_FLAGS: BlockCodeKnownFeatureFlags;
+    /**
+     * Creates a new BlockModelV3 builder with the specified data model and options.
+     *
+     * @example
+     * const dataModel = DataModel.create<BlockData>(() => ({ numbers: [], labels: [] }));
+     * BlockModelV3.create({ dataModel })
+     *   .args((data) => ({ numbers: data.numbers }))
+     *   .sections(() => [{ type: 'link', href: '/', label: 'Main' }])
+     *   .done();
+     *
+     * @param options Configuration options including required data model
+     */
+    static create<Data extends Record<string, unknown>>(options: BlockModelV3Options<Data>): BlockModelV3<NoOb, {}, Data>;
+    /**
+     * Add output cell wrapped with additional status information to the configuration
+     *
+     * @param key output cell name, that can be later used to retrieve the rendered value
+     * @param rf  callback calculating output value using context, that allows to access
+     *            workflows outputs and interact with platforma drivers
+     * @param flags additional flags that may alter lambda rendering procedure
+     * */
+    output<const Key extends string, const RF extends RenderFunction<Args, Data>>(key: Key, rf: RF, flags: ConfigRenderLambdaFlags & {
+        withStatus: true;
+    }): BlockModelV3<Args, OutputsCfg & {
+        [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> & {
+            withStatus: true;
+        };
+    }, Data, Href>;
+    /**
+     * Add output cell to the configuration
+     *
+     * @param key output cell name, that can be later used to retrieve the rendered value
+     * @param rf  callback calculating output value using context, that allows to access
+     *            workflows outputs and interact with platforma drivers
+     * @param flags additional flags that may alter lambda rendering procedure
+     * */
+    output<const Key extends string, const RF extends RenderFunction<Args, Data>>(key: Key, rf: RF, flags?: ConfigRenderLambdaFlags): BlockModelV3<Args, OutputsCfg & {
+        [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>>;
+    }, Data, Href>;
+    /** Shortcut for {@link output} with retentive flag set to true. */
+    retentiveOutput<const Key extends string, const RF extends RenderFunction<Args, Data>>(key: Key, rf: RF): BlockModelV3<Args, OutputsCfg & {
+        [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>>;
+    }, Data, Href>;
+    /** Shortcut for {@link output} with withStatus flag set to true. */
+    outputWithStatus<const Key extends string, const RF extends RenderFunction<Args, Data>>(key: Key, rf: RF): BlockModelV3<Args, OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> & {
+        withStatus: true;
+    }; }, Data, Href>;
+    /**
+     * Sets a function to derive block args from data.
+     * This is called during setData to compute the args that will be used for block execution.
+     *
+     * @example
+     * .args<BlockArgs>((data) => ({ numbers: data.numbers }))
+     *
+     * @example
+     * .args<BlockArgs>((data) => {
+     *   if (data.numbers.length === 0) throw new Error('Numbers required'); // block not ready
+     *   return { numbers: data.numbers };
+     * })
+     */
+    args<Args>(lambda: (data: Data) => Args): BlockModelV3<Args, OutputsCfg, Data, Href>;
+    /**
+     * Sets a function to derive pre-run args from data (optional).
+     * This is called during setData to compute the args that will be used for staging/pre-run phase.
+     *
+     * If not defined, defaults to using the args() function result.
+     * If defined, uses its return value for the staging / prerun phase.
+     *
+     * The staging / prerun phase runs only if currentPrerunArgs differs from the executed
+     * version of prerunArgs (same comparison logic as currentArgs vs prodArgs).
+     *
+     * @example
+     * .prerunArgs((data) => ({ numbers: data.numbers }))
+     *
+     * @example
+     * .prerunArgs((data) => {
+     *   // Return undefined to skip staging for this block
+     *   if (!data.isReady) return undefined;
+     *   return { numbers: data.numbers };
+     * })
+     */
+    prerunArgs(fn: (data: Data) => unknown): BlockModelV3<Args, OutputsCfg, Data, Href>;
+    /** Sets the lambda to generate list of sections in the left block overviews panel. */
+    sections<const Ret extends SectionsExpectedType, const RF extends RenderFunction<Args, Data, Ret>>(rf: RF): BlockModelV3<Args, OutputsCfg, Data, DeriveHref<ReturnType<RF>>>;
+    /** Sets a rendering function to derive block title, shown for the block in the left blocks-overview panel. */
+    title(rf: RenderFunction<Args, Data, string>): BlockModelV3<Args, OutputsCfg, Data, Href>;
+    subtitle(rf: RenderFunction<Args, Data, string>): BlockModelV3<Args, OutputsCfg, Data, Href>;
+    tags(rf: RenderFunction<Args, Data, string[]>): BlockModelV3<Args, OutputsCfg, Data, Href>;
+    /** Sets or overrides feature flags for the block. */
+    withFeatureFlags(flags: Partial<BlockCodeKnownFeatureFlags>): BlockModelV3<Args, OutputsCfg, Data, Href>;
+    /**
+     * Defines how to derive list of upstream references this block is meant to enrich with its exports from block args.
+     * Influences dependency graph construction.
+     */
+    enriches(lambda: (args: Args) => PlRef[]): BlockModelV3<Args, OutputsCfg, Data, Href>;
+    /** Renders all provided block settings into a pre-configured platforma API
+     * instance, that can be used in frontend to interact with block data, and
+     * other features provided by the platforma to the block. */
+    done(): PlatformaExtended<PlatformaV3<Args, InferOutputsFromLambdas<OutputsCfg>, Data, Href>>;
+    _done(): PlatformaExtended<PlatformaV3<Args, InferOutputsFromLambdas<OutputsCfg>, Data, Href>>;
+}
+export type Expect<T extends true> = T;
+export type Equal<X, Y> = (<T>() => T extends X ? 1 : 2) extends (<T>() => T extends Y ? 1 : 2) ? true : false;
+export type Merge<A, B> = {
+    [K in keyof A | keyof B]: K extends keyof B ? B[K] : K extends keyof A ? A[K] : never;
+};
+export {};
+//# sourceMappingURL=block_model.d.ts.map

package/dist/block_model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"block_model.d.ts","sourceRoot":"","sources":["../src/block_model.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,EAClB,YAAY,EAEZ,KAAK,EACL,0BAA0B,EAE3B,MAAM,iCAAiC,CAAC;AAEzC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,KAAK,EAAE,yBAAyB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAI1E,OAAO,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACV,kBAAkB,EAClB,UAAU,EACV,uBAAuB,EACvB,uBAAuB,EACxB,MAAM,WAAW,CAAC;AAKnB,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAErD,KAAK,oBAAoB,GAAG,SAAS,YAAY,EAAE,CAAC;AAEpD,KAAK,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAoBlC,0CAA0C;AAC1C,MAAM,WAAW,mBAAmB,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACvE,8DAA8D;IAC9D,SAAS,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;IAC3B,sDAAsD;IACtD,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC;AAED;;;iDAGiD;AACjD,qBAAa,YAAY,CACvB,IAAI,EACJ,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,EACrD,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9D,IAAI,SAAS,IAAI,MAAM,EAAE,GAAG,GAAG;IAG7B,OAAO,CAAC,QAAQ,CAAC,MAAM;IADzB,OAAO;IAIP,gBAAuB,2BAA2B,EAAE,0BAA0B,CAI5E;IAEF;;;;;;;;;;;OAWG;WACW,MAAM,CAAC,IAAI,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvD,OAAO,EAAE,mBAAmB,CAAC,IAAI,CAAC,GACjC,YAAY,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,CAAC;IAsB/B;;;;;;;SAOK;IACE,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,EACjF,GAAG,EAAE,GAAG,EACR,EAAE,EAAE,EAAE,EACN,KAAK,EAAE,uBAAuB,GAAG;QAAE,UAAU,EAAE,IAAI,CAAA;KAAE,GACpD,YAAY,CACb,IAAI,EACF,UAAU,GAAG;SAAG,CAAC,IAAI,GAAG,GAAG,kBAAkB,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC,GAAG;YAAE,UAAU,EAAE,IAAI,CAAA;SAAE;KAAE,EACrG,IAAI,EACJ,IAAI,CACP;IACD;;;;;;;SAOK;IACE,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,EACjF,GAAG,EAAE,GAAG,EACR,EAAE,EAAE,EAAE,EACN,KAAK,CAAC,EAAE,uBAAuB,GAC9B,YAAY,CACb,IAAI,EACJ,UAAU,GAAG;SAAG,CAAC,IAAI,GAAG,GAAG,kBAAkB,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC;KAAE,EAC9E,IAAI,EACJ,IAAI,CACL;IAeD,mEAAmE;IAC5D,eAAe,CAAC,KAAK,CAAC,GAAG,SAAS,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,EAC1F,GAAG,EAAE,GAAG,EACR,EAAE,EAAE,EAAE,GACL,YAAY,CACX,IAAI,EACN,UAAU,GAAG;SAAG,CAAC,IAAI,GAAG,GAAG,kBAAkB,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC;KAAE,EAC9E,IAAI,EACJ,IAAI,CACH;IAIH,oEAAoE;IAC7D,gBAAgB,CAAC,KAAK,CAAC,GAAG,SAAS,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,EAC3F,GAAG,EAAE,GAAG,EACR,EAAE,EAAE,EAAE,sCApDY,CAAC;oBAA4E,IAAI;;IAyDrG;;;;;;;;;;;;OAYG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,IAAI,GAAG,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC;IAO3F;;;;;;;;;;;;;;;;;;;OAmBG;IACI,UAAU,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC;IAO1F,sFAAsF;IAC/E,QAAQ,CACb,KAAK,CAAC,GAAG,SAAS,oBAAoB,EACtC,KAAK,CAAC,EAAE,SAAS,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,EAChD,EAAE,EAAE,EAAE,GAAG,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IAQ3E,8GAA8G;IACvG,KAAK,CACV,EAAE,EAAE,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,GACrC,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC;IAOtC,QAAQ,CACb,EAAE,EAAE,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,GACrC,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC;IAOtC,IAAI,CACT,EAAE,EAAE,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,GACvC,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC;IAO7C,qDAAqD;IAC9C,gBAAgB,CAAC,KAAK,EAAE,OAAO,CAAC,0BAA0B,CAAC,GAAG,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC;IAO/G;;;OAGG;IACI,QAAQ,CACb,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,KAAK,EAAE,GAC9B,YAAY,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,CAAC;IAO7C;;gEAE4D;IACrD,IAAI,IAAI,iBAAiB,CAAC,WAAW,CAC1C,IAAI,EACJ,uBAAuB,CAAC,UAAU,CAAC,EACnC,IAAI,EACJ,IAAI,CACL,CAAC;IAMK,KAAK,IAAI,iBAAiB,CAAC,WAAW,CAC3C,IAAI,EACJ,uBAAuB,CAAC,UAAU,CAAC,EACnC,IAAI,EACJ,IAAI,CACL,CAAC;CAuDH;AAID,MAAM,MAAM,MAAM,CAAC,CAAC,SAAS,IAAI,IAAI,CAAC,CAAC;AAEvC,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,IACpB,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC;AAEvF,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI;KACvB,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CACtF,CAAC"}

package/dist/block_model.js

@@ -0,0 +1,220 @@
+import { createAndRegisterRenderLambda, createRenderLambda, isInUI, getPlatformaInstance } from './internal.js';
+import { RenderCtx } from './render/api.js';
+import '@milaboratories/pl-model-common';
+import './render/util/label.js';
+import 'canonicalize';
+import { PlatformaSDKVersion } from './version.js';
+import './block_storage_vm.js';
+import { downgradeCfgOrLambda } from './bconfig/normalization.js';
+import { isConfigLambda } from './bconfig/types.js';
+
+/** Main entry point that each block should use in it's "config" module. Don't forget
+ * to call {@link done()} at the end of configuration. Value returned by this builder must be
+ * exported as constant with name "platforma" from the "config" module.
+ * API version is 3 (for UI) and 2 (for model) */
+class BlockModelV3 {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+    static INITIAL_BLOCK_FEATURE_FLAGS = {
+        supportsLazyState: true,
+        requiresUIAPIVersion: 3,
+        requiresModelAPIVersion: 2,
+    };
+    /**
+     * Creates a new BlockModelV3 builder with the specified data model and options.
+     *
+     * @example
+     * const dataModel = DataModel.create<BlockData>(() => ({ numbers: [], labels: [] }));
+     * BlockModelV3.create({ dataModel })
+     *   .args((data) => ({ numbers: data.numbers }))
+     *   .sections(() => [{ type: 'link', href: '/', label: 'Main' }])
+     *   .done();
+     *
+     * @param options Configuration options including required data model
+     */
+    static create(options) {
+        const { dataModel, renderingMode = 'Heavy' } = options;
+        // Register data model callbacks for VM use (initialData and upgrade)
+        dataModel.registerCallbacks();
+        return new BlockModelV3({
+            renderingMode,
+            dataModel,
+            outputs: {},
+            // Register default sections callback (returns empty array)
+            sections: createAndRegisterRenderLambda({ handle: 'sections', lambda: () => [] }, true),
+            title: undefined,
+            subtitle: undefined,
+            tags: undefined,
+            enrichmentTargets: undefined,
+            featureFlags: { ...BlockModelV3.INITIAL_BLOCK_FEATURE_FLAGS },
+            args: undefined,
+            prerunArgs: undefined,
+        });
+    }
+    output(key, cfgOrRf, flags = {}) {
+        return new BlockModelV3({
+            ...this.config,
+            outputs: {
+                ...this.config.outputs,
+                [key]: createAndRegisterRenderLambda({ handle: `output#${key}`, lambda: () => cfgOrRf(new RenderCtx()), ...flags }),
+            },
+        });
+    }
+    /** Shortcut for {@link output} with retentive flag set to true. */
+    retentiveOutput(key, rf) {
+        return this.output(key, rf, { retentive: true });
+    }
+    /** Shortcut for {@link output} with withStatus flag set to true. */
+    outputWithStatus(key, rf) {
+        return this.output(key, rf, { withStatus: true });
+    }
+    /**
+     * Sets a function to derive block args from data.
+     * This is called during setData to compute the args that will be used for block execution.
+     *
+     * @example
+     * .args<BlockArgs>((data) => ({ numbers: data.numbers }))
+     *
+     * @example
+     * .args<BlockArgs>((data) => {
+     *   if (data.numbers.length === 0) throw new Error('Numbers required'); // block not ready
+     *   return { numbers: data.numbers };
+     * })
+     */
+    args(lambda) {
+        return new BlockModelV3({
+            ...this.config,
+            args: createAndRegisterRenderLambda({ handle: 'args', lambda }),
+        });
+    }
+    /**
+     * Sets a function to derive pre-run args from data (optional).
+     * This is called during setData to compute the args that will be used for staging/pre-run phase.
+     *
+     * If not defined, defaults to using the args() function result.
+     * If defined, uses its return value for the staging / prerun phase.
+     *
+     * The staging / prerun phase runs only if currentPrerunArgs differs from the executed
+     * version of prerunArgs (same comparison logic as currentArgs vs prodArgs).
+     *
+     * @example
+     * .prerunArgs((data) => ({ numbers: data.numbers }))
+     *
+     * @example
+     * .prerunArgs((data) => {
+     *   // Return undefined to skip staging for this block
+     *   if (!data.isReady) return undefined;
+     *   return { numbers: data.numbers };
+     * })
+     */
+    prerunArgs(fn) {
+        return new BlockModelV3({
+            ...this.config,
+            prerunArgs: createAndRegisterRenderLambda({ handle: 'prerunArgs', lambda: fn }),
+        });
+    }
+    /** Sets the lambda to generate list of sections in the left block overviews panel. */
+    sections(rf) {
+        return new BlockModelV3({
+            ...this.config,
+            // Replace the default sections callback with the user-provided one
+            sections: createAndRegisterRenderLambda({ handle: 'sections', lambda: () => rf(new RenderCtx()) }, true),
+        });
+    }
+    /** Sets a rendering function to derive block title, shown for the block in the left blocks-overview panel. */
+    title(rf) {
+        return new BlockModelV3({
+            ...this.config,
+            title: createAndRegisterRenderLambda({ handle: 'title', lambda: () => rf(new RenderCtx()) }),
+        });
+    }
+    subtitle(rf) {
+        return new BlockModelV3({
+            ...this.config,
+            subtitle: createAndRegisterRenderLambda({ handle: 'subtitle', lambda: () => rf(new RenderCtx()) }),
+        });
+    }
+    tags(rf) {
+        return new BlockModelV3({
+            ...this.config,
+            tags: createAndRegisterRenderLambda({ handle: 'tags', lambda: () => rf(new RenderCtx()) }),
+        });
+    }
+    /** Sets or overrides feature flags for the block. */
+    withFeatureFlags(flags) {
+        return new BlockModelV3({
+            ...this.config,
+            featureFlags: { ...this.config.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.
+     */
+    enriches(lambda) {
+        return new BlockModelV3({
+            ...this.config,
+            enrichmentTargets: createAndRegisterRenderLambda({ handle: 'enrichmentTargets', lambda: lambda }),
+        });
+    }
+    /** Renders all provided block settings into a pre-configured platforma API
+     * instance, that can be used in frontend to interact with block data, and
+     * other features provided by the platforma to the block. */
+    done() {
+        return this.withFeatureFlags({
+            ...this.config.featureFlags,
+        })._done();
+    }
+    _done() {
+        if (this.config.args === undefined)
+            throw new Error('Args rendering function not set.');
+        const apiVersion = 3;
+        const migrationCount = this.config.dataModel.migrationCount;
+        const blockConfig = {
+            v4: {
+                configVersion: 4,
+                modelAPIVersion: 2,
+                sdkVersion: PlatformaSDKVersion,
+                renderingMode: this.config.renderingMode,
+                args: this.config.args,
+                prerunArgs: this.config.prerunArgs,
+                // Reference to __pl_data_initial callback registered by DataModel
+                initialData: createRenderLambda({ handle: '__pl_data_initial' }),
+                sections: this.config.sections,
+                title: this.config.title,
+                outputs: this.config.outputs,
+                enrichmentTargets: this.config.enrichmentTargets,
+                featureFlags: this.config.featureFlags,
+                // Generate migration descriptors (indices for metadata)
+                migrations: migrationCount > 0
+                    ? Array.from({ length: migrationCount }, (_, i) => ({ index: i }))
+                    : undefined,
+            },
+            // fields below are added to allow previous desktop versions read generated configs
+            sdkVersion: PlatformaSDKVersion,
+            renderingMode: this.config.renderingMode,
+            sections: this.config.sections,
+            outputs: Object.fromEntries(Object.entries(this.config.outputs).map(([key, value]) => [key, downgradeCfgOrLambda(value)])),
+        };
+        globalThis.platformaApiVersion = apiVersion;
+        if (!isInUI())
+            // we are in the configuration rendering routine, not in actual UI
+            return { config: blockConfig };
+        // normal operation inside the UI
+        else
+            return {
+                ...getPlatformaInstance({ sdkVersion: PlatformaSDKVersion, apiVersion }),
+                blockModelInfo: {
+                    outputs: Object.fromEntries(Object.entries(this.config.outputs)
+                        .map(([key, value]) => [key, {
+                            withStatus: Boolean(isConfigLambda(value) && value.withStatus),
+                        }])),
+                },
+            };
+    }
+}
+
+export { BlockModelV3 };
+//# sourceMappingURL=block_model.js.map