@platforma-sdk/model 1.42.16 → 1.42.22

package/dist/bconfig/index.d.ts

@@ -3,4 +3,3 @@ export * from './normalization';
 export * from './util';
 export * from './v3';
 export * from './types';
-//# sourceMappingURL=index.d.ts.map

package/dist/bconfig/lambdas.d.ts

@@ -30,4 +30,3 @@ export interface ConfigRenderLambda<_Return = unknown> extends ConfigRenderLambd
     handle: string;
 }
 export type ExtractFunctionHandleReturn<Func extends ConfigRenderLambda> = Func extends ConfigRenderLambda<infer Return> ? Return : never;
-//# sourceMappingURL=lambdas.d.ts.map

package/dist/bconfig/normalization.cjs

@@ -0,0 +1,19 @@
+'use strict';
+
+var plModelCommon = require('@milaboratories/pl-model-common');
+var types = require('./types.cjs');
+
+function downgradeCfgOrLambda(data) {
+    if (data === undefined)
+        return undefined;
+    if (types.isConfigLambda(data))
+        return data.handle;
+    return data;
+}
+function extractConfig(cfg) {
+    return plModelCommon.extractConfigGeneric(cfg);
+}
+
+exports.downgradeCfgOrLambda = downgradeCfgOrLambda;
+exports.extractConfig = extractConfig;
+//# sourceMappingURL=normalization.cjs.map

package/dist/bconfig/normalization.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalization.cjs","sources":["../../src/bconfig/normalization.ts"],"sourcesContent":["import { extractConfigGeneric, type BlockConfigContainer } from '@milaboratories/pl-model-common';\nimport type { TypedConfigOrConfigLambda, TypedConfigOrString } from './types';\nimport { isConfigLambda } from './types';\nimport type { BlockConfig } from './v3';\n\nexport function downgradeCfgOrLambda(data: TypedConfigOrConfigLambda): TypedConfigOrString;\nexport function downgradeCfgOrLambda(\n  data: TypedConfigOrConfigLambda | undefined\n): TypedConfigOrString | undefined;\nexport function downgradeCfgOrLambda(\n  data: TypedConfigOrConfigLambda | undefined,\n): TypedConfigOrString | undefined {\n  if (data === undefined) return undefined;\n  if (isConfigLambda(data)) return data.handle;\n  return data;\n}\n\nexport function extractConfig(cfg: BlockConfigContainer): BlockConfig {\n  return extractConfigGeneric(cfg) as BlockConfig;\n}\n"],"names":["isConfigLambda","extractConfigGeneric"],"mappings":";;;;;AASM,SAAU,oBAAoB,CAClC,IAA2C,EAAA;IAE3C,IAAI,IAAI,KAAK,SAAS;AAAE,QAAA,OAAO,SAAS;IACxC,IAAIA,oBAAc,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC,MAAM;AAC5C,IAAA,OAAO,IAAI;AACb;AAEM,SAAU,aAAa,CAAC,GAAyB,EAAA;AACrD,IAAA,OAAOC,kCAAoB,CAAC,GAAG,CAAgB;AACjD;;;;;"}

package/dist/bconfig/normalization.d.ts

@@ -4,4 +4,3 @@ import { BlockConfig } from './v3';
 export declare function downgradeCfgOrLambda(data: TypedConfigOrConfigLambda): TypedConfigOrString;
 export declare function downgradeCfgOrLambda(data: TypedConfigOrConfigLambda | undefined): TypedConfigOrString | undefined;
 export declare function extractConfig(cfg: BlockConfigContainer): BlockConfig;
-//# sourceMappingURL=normalization.d.ts.map

package/dist/bconfig/normalization.js

@@ -0,0 +1,16 @@
+import { extractConfigGeneric } from '@milaboratories/pl-model-common';
+import { isConfigLambda } from './types.js';
+
+function downgradeCfgOrLambda(data) {
+    if (data === undefined)
+        return undefined;
+    if (isConfigLambda(data))
+        return data.handle;
+    return data;
+}
+function extractConfig(cfg) {
+    return extractConfigGeneric(cfg);
+}
+
+export { downgradeCfgOrLambda, extractConfig };
+//# sourceMappingURL=normalization.js.map

package/dist/bconfig/normalization.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalization.js","sources":["../../src/bconfig/normalization.ts"],"sourcesContent":["import { extractConfigGeneric, type BlockConfigContainer } from '@milaboratories/pl-model-common';\nimport type { TypedConfigOrConfigLambda, TypedConfigOrString } from './types';\nimport { isConfigLambda } from './types';\nimport type { BlockConfig } from './v3';\n\nexport function downgradeCfgOrLambda(data: TypedConfigOrConfigLambda): TypedConfigOrString;\nexport function downgradeCfgOrLambda(\n  data: TypedConfigOrConfigLambda | undefined\n): TypedConfigOrString | undefined;\nexport function downgradeCfgOrLambda(\n  data: TypedConfigOrConfigLambda | undefined,\n): TypedConfigOrString | undefined {\n  if (data === undefined) return undefined;\n  if (isConfigLambda(data)) return data.handle;\n  return data;\n}\n\nexport function extractConfig(cfg: BlockConfigContainer): BlockConfig {\n  return extractConfigGeneric(cfg) as BlockConfig;\n}\n"],"names":[],"mappings":";;;AASM,SAAU,oBAAoB,CAClC,IAA2C,EAAA;IAE3C,IAAI,IAAI,KAAK,SAAS;AAAE,QAAA,OAAO,SAAS;IACxC,IAAI,cAAc,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC,MAAM;AAC5C,IAAA,OAAO,IAAI;AACb;AAEM,SAAU,aAAa,CAAC,GAAyB,EAAA;AACrD,IAAA,OAAO,oBAAoB,CAAC,GAAG,CAAgB;AACjD;;;;"}

package/dist/bconfig/types.cjs

@@ -0,0 +1,8 @@
+'use strict';
+
+function isConfigLambda(cfgOrFh) {
+    return cfgOrFh.__renderLambda === true;
+}
+
+exports.isConfigLambda = isConfigLambda;
+//# sourceMappingURL=types.cjs.map

package/dist/bconfig/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sources":["../../src/bconfig/types.ts"],"sourcesContent":["import type { TypedConfig } from '../config';\nimport type { ConfigRenderLambda } from './lambdas';\n\nexport function isConfigLambda(\n  cfgOrFh: TypedConfigOrConfigLambda,\n): cfgOrFh is ConfigRenderLambda {\n  return (cfgOrFh as any).__renderLambda === true;\n}\n\nexport type TypedConfigOrConfigLambda = TypedConfig | ConfigRenderLambda;\n\n/** @deprecated */\nexport type TypedConfigOrString = TypedConfig | string;\n"],"names":[],"mappings":";;AAGM,SAAU,cAAc,CAC5B,OAAkC,EAAA;AAElC,IAAA,OAAQ,OAAe,CAAC,cAAc,KAAK,IAAI;AACjD;;;;"}

package/dist/bconfig/types.d.ts

@@ -4,4 +4,3 @@ export declare function isConfigLambda(cfgOrFh: TypedConfigOrConfigLambda): cfgO
 export type TypedConfigOrConfigLambda = TypedConfig | ConfigRenderLambda;
 /** @deprecated */
 export type TypedConfigOrString = TypedConfig | string;
-//# sourceMappingURL=types.d.ts.map

package/dist/bconfig/types.js

@@ -0,0 +1,6 @@
+function isConfigLambda(cfgOrFh) {
+    return cfgOrFh.__renderLambda === true;
+}
+
+export { isConfigLambda };
+//# sourceMappingURL=types.js.map

package/dist/bconfig/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sources":["../../src/bconfig/types.ts"],"sourcesContent":["import type { TypedConfig } from '../config';\nimport type { ConfigRenderLambda } from './lambdas';\n\nexport function isConfigLambda(\n  cfgOrFh: TypedConfigOrConfigLambda,\n): cfgOrFh is ConfigRenderLambda {\n  return (cfgOrFh as any).__renderLambda === true;\n}\n\nexport type TypedConfigOrConfigLambda = TypedConfig | ConfigRenderLambda;\n\n/** @deprecated */\nexport type TypedConfigOrString = TypedConfig | string;\n"],"names":[],"mappings":"AAGM,SAAU,cAAc,CAC5B,OAAkC,EAAA;AAElC,IAAA,OAAQ,OAAe,CAAC,cAAc,KAAK,IAAI;AACjD;;;;"}

package/dist/bconfig/util.d.ts

@@ -4,4 +4,3 @@ export type DeriveHref<S> = S extends readonly BlockSection[] ? OnlyString<Extra
     type: 'link';
 }>['href']> : never;
 export {};
-//# sourceMappingURL=util.d.ts.map

package/dist/bconfig/v3.d.ts

@@ -3,4 +3,3 @@ import { TypedConfigOrConfigLambda } from './types';
 import { ConfigRenderLambda } from './lambdas';
 export type BlockConfigV3<Args = unknown, UiState = unknown, Outputs extends Record<string, TypedConfigOrConfigLambda> = Record<string, TypedConfigOrConfigLambda>> = BlockConfigV3Generic<Args, UiState, TypedConfigOrConfigLambda, ConfigRenderLambda, Outputs>;
 export type BlockConfig = BlockConfigV3;
-//# sourceMappingURL=v3.d.ts.map

package/dist/block_api_v1.d.ts

@@ -59,4 +59,3 @@ export interface BlockApiV1<Args = unknown, Outputs extends BlockOutputsBase = B
      * */
     setNavigationState(state: NavigationState<Href>): Promise<void>;
 }
-//# sourceMappingURL=block_api_v1.d.ts.map

package/dist/block_api_v2.d.ts

@@ -47,4 +47,3 @@ export interface BlockApiV2<Args = unknown, Outputs extends BlockOutputsBase = B
      * */
     dispose(): Promise<ResultOrError<void>>;
 }
-//# sourceMappingURL=block_api_v2.d.ts.map

package/dist/block_state_patch.d.ts

@@ -2,4 +2,3 @@ import { Unionize } from './unionize';
 import { BlockOutputsBase, BlockState } from '@milaboratories/pl-model-common';
 /** Patch for the BlockState, pushed by onStateUpdates method in SDK. */
 export type BlockStatePatch<Args = unknown, Outputs extends BlockOutputsBase = BlockOutputsBase, UiState = unknown, Href extends `/${string}` = `/${string}`> = Unionize<BlockState<Args, Outputs, UiState, Href>>;
-//# sourceMappingURL=block_state_patch.d.ts.map

package/dist/block_state_util.cjs

@@ -0,0 +1,28 @@
+'use strict';
+
+class OutputError extends Error {
+    errors;
+    moreErrors;
+    constructor(errors, moreErrors) {
+        super(`${errors.length}${moreErrors ? '+' : ''} errors, first error: ` + errors[0].message);
+        this.errors = errors;
+        this.moreErrors = moreErrors;
+    }
+}
+function readOutput(outputValue) {
+    if (!outputValue.ok)
+        throw new OutputError(outputValue.errors, outputValue.moreErrors);
+    return outputValue.value;
+}
+function wrapOutputs(outputs) {
+    return new Proxy(outputs, {
+        get(target, key) {
+            return readOutput(target[key]);
+        },
+    });
+}
+
+exports.OutputError = OutputError;
+exports.readOutput = readOutput;
+exports.wrapOutputs = wrapOutputs;
+//# sourceMappingURL=block_state_util.cjs.map

package/dist/block_state_util.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"block_state_util.cjs","sources":["../src/block_state_util.ts"],"sourcesContent":["import type { BlockOutputsBase, ValueOrErrors } from '@milaboratories/pl-model-common';\nimport type { ErrorLike } from '@milaboratories/pl-error-like';\n\nexport class OutputError extends Error {\n  constructor(\n    public readonly errors: ErrorLike[],\n    public readonly moreErrors: boolean,\n  ) {\n    super(`${errors.length}${moreErrors ? '+' : ''} errors, first error: ` + errors[0].message);\n  }\n}\n\nexport function readOutput<T>(outputValue: ValueOrErrors<T>): T {\n  if (!outputValue.ok) throw new OutputError(outputValue.errors, outputValue.moreErrors);\n  return outputValue.value;\n}\n\ntype ExtractValueType<V extends ValueOrErrors<unknown>> = Extract<V, { ok: true }>['value'];\ntype SimpleOutputs<Outputs extends BlockOutputsBase> = {\n  [Key in keyof Outputs]: ExtractValueType<Outputs[Key]>;\n};\n\nexport function wrapOutputs<Outputs extends BlockOutputsBase>(\n  outputs: Outputs,\n): SimpleOutputs<Outputs> {\n  return new Proxy(outputs, {\n    get(target, key: string) {\n      return readOutput(target[key]);\n    },\n  }) as SimpleOutputs<Outputs>;\n}\n"],"names":[],"mappings":";;AAGM,MAAO,WAAY,SAAQ,KAAK,CAAA;AAElB,IAAA,MAAA;AACA,IAAA,UAAA;IAFlB,WAAA,CACkB,MAAmB,EACnB,UAAmB,EAAA;QAEnC,KAAK,CAAC,CAAA,EAAG,MAAM,CAAC,MAAM,GAAG,UAAU,GAAG,GAAG,GAAG,EAAE,CAAA,sBAAA,CAAwB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAH3E,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,UAAU,GAAV,UAAU;IAG5B;AACD;AAEK,SAAU,UAAU,CAAI,WAA6B,EAAA;IACzD,IAAI,CAAC,WAAW,CAAC,EAAE;QAAE,MAAM,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC;IACtF,OAAO,WAAW,CAAC,KAAK;AAC1B;AAOM,SAAU,WAAW,CACzB,OAAgB,EAAA;AAEhB,IAAA,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE;QACxB,GAAG,CAAC,MAAM,EAAE,GAAW,EAAA;AACrB,YAAA,OAAO,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC;AACF,KAAA,CAA2B;AAC9B;;;;;;"}

package/dist/block_state_util.d.ts

@@ -14,4 +14,3 @@ type SimpleOutputs<Outputs extends BlockOutputsBase> = {
 };
 export declare function wrapOutputs<Outputs extends BlockOutputsBase>(outputs: Outputs): SimpleOutputs<Outputs>;
 export {};
-//# sourceMappingURL=block_state_util.d.ts.map

package/dist/block_state_util.js

@@ -0,0 +1,24 @@
+class OutputError extends Error {
+    errors;
+    moreErrors;
+    constructor(errors, moreErrors) {
+        super(`${errors.length}${moreErrors ? '+' : ''} errors, first error: ` + errors[0].message);
+        this.errors = errors;
+        this.moreErrors = moreErrors;
+    }
+}
+function readOutput(outputValue) {
+    if (!outputValue.ok)
+        throw new OutputError(outputValue.errors, outputValue.moreErrors);
+    return outputValue.value;
+}
+function wrapOutputs(outputs) {
+    return new Proxy(outputs, {
+        get(target, key) {
+            return readOutput(target[key]);
+        },
+    });
+}
+
+export { OutputError, readOutput, wrapOutputs };
+//# sourceMappingURL=block_state_util.js.map

package/dist/block_state_util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"block_state_util.js","sources":["../src/block_state_util.ts"],"sourcesContent":["import type { BlockOutputsBase, ValueOrErrors } from '@milaboratories/pl-model-common';\nimport type { ErrorLike } from '@milaboratories/pl-error-like';\n\nexport class OutputError extends Error {\n  constructor(\n    public readonly errors: ErrorLike[],\n    public readonly moreErrors: boolean,\n  ) {\n    super(`${errors.length}${moreErrors ? '+' : ''} errors, first error: ` + errors[0].message);\n  }\n}\n\nexport function readOutput<T>(outputValue: ValueOrErrors<T>): T {\n  if (!outputValue.ok) throw new OutputError(outputValue.errors, outputValue.moreErrors);\n  return outputValue.value;\n}\n\ntype ExtractValueType<V extends ValueOrErrors<unknown>> = Extract<V, { ok: true }>['value'];\ntype SimpleOutputs<Outputs extends BlockOutputsBase> = {\n  [Key in keyof Outputs]: ExtractValueType<Outputs[Key]>;\n};\n\nexport function wrapOutputs<Outputs extends BlockOutputsBase>(\n  outputs: Outputs,\n): SimpleOutputs<Outputs> {\n  return new Proxy(outputs, {\n    get(target, key: string) {\n      return readOutput(target[key]);\n    },\n  }) as SimpleOutputs<Outputs>;\n}\n"],"names":[],"mappings":"AAGM,MAAO,WAAY,SAAQ,KAAK,CAAA;AAElB,IAAA,MAAA;AACA,IAAA,UAAA;IAFlB,WAAA,CACkB,MAAmB,EACnB,UAAmB,EAAA;QAEnC,KAAK,CAAC,CAAA,EAAG,MAAM,CAAC,MAAM,GAAG,UAAU,GAAG,GAAG,GAAG,EAAE,CAAA,sBAAA,CAAwB,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;QAH3E,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,UAAU,GAAV,UAAU;IAG5B;AACD;AAEK,SAAU,UAAU,CAAI,WAA6B,EAAA;IACzD,IAAI,CAAC,WAAW,CAAC,EAAE;QAAE,MAAM,IAAI,WAAW,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,CAAC;IACtF,OAAO,WAAW,CAAC,KAAK;AAC1B;AAOM,SAAU,WAAW,CACzB,OAAgB,EAAA;AAEhB,IAAA,OAAO,IAAI,KAAK,CAAC,OAAO,EAAE;QACxB,GAAG,CAAC,MAAM,EAAE,GAAW,EAAA;AACrB,YAAA,OAAO,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAChC,CAAC;AACF,KAAA,CAA2B;AAC9B;;;;"}

package/dist/branding.d.ts

@@ -4,4 +4,3 @@ type Brand<B> = {
 };
 export type Branded<T, B> = T & Brand<B>;
 export {};
-//# sourceMappingURL=branding.d.ts.map

package/dist/builder.cjs

@@ -0,0 +1,166 @@
+'use strict';
+
+var actions = require('./config/actions.cjs');
+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');
+var normalization = require('./bconfig/normalization.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. */
+class BlockModel {
+    _renderingMode;
+    _initialArgs;
+    _initialUiState;
+    _outputs;
+    _inputsValid;
+    _sections;
+    _title;
+    _enrichmentTargets;
+    _featureFlags;
+    constructor(_renderingMode, _initialArgs, _initialUiState, _outputs, _inputsValid, _sections, _title, _enrichmentTargets, _featureFlags) {
+        this._renderingMode = _renderingMode;
+        this._initialArgs = _initialArgs;
+        this._initialUiState = _initialUiState;
+        this._outputs = _outputs;
+        this._inputsValid = _inputsValid;
+        this._sections = _sections;
+        this._title = _title;
+        this._enrichmentTargets = _enrichmentTargets;
+        this._featureFlags = _featureFlags;
+    }
+    static INITIAL_BLOCK_FEATURE_FLAGS = {
+        supportsLazyState: true,
+        requiresUIAPIVersion: 1,
+        requiresModelAPIVersion: 1,
+    };
+    static create(renderingMode = 'Heavy') {
+        return new BlockModel(renderingMode, undefined, {}, {}, actions.getImmediate(true), actions.getImmediate([]), undefined, undefined, { ...BlockModel.INITIAL_BLOCK_FEATURE_FLAGS });
+    }
+    output(key, cfgOrRf, flags = {}) {
+        if (typeof cfgOrRf === 'function') {
+            const handle = `output#${key}`;
+            internal.tryRegisterCallback(handle, () => cfgOrRf(new api.RenderCtx()));
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, {
+                ...this._outputs,
+                [key]: {
+                    __renderLambda: true,
+                    handle,
+                    ...flags,
+                },
+            }, this._inputsValid, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+        }
+        else
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, {
+                ...this._outputs,
+                [key]: cfgOrRf,
+            }, this._inputsValid, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    /** Shortcut for {@link output} with retentive flag set to true. */
+    retentiveOutput(key, rf) {
+        return this.output(key, rf, { retentive: true });
+    }
+    argsValid(cfgOrRf) {
+        if (typeof cfgOrRf === 'function') {
+            internal.tryRegisterCallback('inputsValid', () => cfgOrRf(new api.RenderCtx()));
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, {
+                __renderLambda: true,
+                handle: 'inputsValid',
+            }, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+        }
+        else
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, cfgOrRf, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    sections(arrOrCfgOrRf) {
+        if (Array.isArray(arrOrCfgOrRf)) {
+            return this.sections(actions.getImmediate(arrOrCfgOrRf));
+        }
+        else if (typeof arrOrCfgOrRf === 'function') {
+            internal.tryRegisterCallback('sections', () => arrOrCfgOrRf(new api.RenderCtx()));
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, this._inputsValid, { __renderLambda: true, handle: 'sections' }, this._title, this._enrichmentTargets, this._featureFlags);
+        }
+        else
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, this._inputsValid, arrOrCfgOrRf, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    /** Sets a rendering function to derive block title, shown for the block in the left blocks-overview panel. */
+    title(rf) {
+        internal.tryRegisterCallback('title', () => rf(new api.RenderCtx()));
+        return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, this._inputsValid, this._sections, { __renderLambda: true, handle: 'title' }, this._enrichmentTargets, this._featureFlags);
+    }
+    /**
+     * Sets initial args for the block, this value must be specified.
+     * @deprecated use {@link withArgs}
+     * */
+    initialArgs(value) {
+        return new BlockModel(this._renderingMode, value, this._initialUiState, this._outputs, this._inputsValid, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    /** Sets initial args for the block, this value must be specified. */
+    withArgs(initialValue) {
+        return new BlockModel(this._renderingMode, initialValue, this._initialUiState, this._outputs, this._inputsValid, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    /** Defines type and sets initial value for block UiState. */
+    withUiState(initialValue) {
+        return new BlockModel(this._renderingMode, this._initialArgs, initialValue, this._outputs, this._inputsValid, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    /** Sets or overrides feature flags for the block. */
+    withFeatureFlags(flags) {
+        return new BlockModel(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.
+     */
+    enriches(lambda) {
+        internal.tryRegisterCallback('enrichmentTargets', lambda);
+        return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, this._inputsValid, this._sections, this._title, { __renderLambda: true, handle: 'enrichmentTargets' }, this._featureFlags);
+    }
+    /** 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. */
+    done(apiVersion) {
+        const requiresUIAPIVersion = apiVersion ?? 1;
+        return this.withFeatureFlags({
+            ...this._featureFlags,
+            requiresUIAPIVersion,
+        })._done(requiresUIAPIVersion);
+    }
+    _done(apiVersion) {
+        if (this._initialArgs === undefined)
+            throw new Error('Initial arguments not set.');
+        const config = {
+            v3: {
+                sdkVersion: version.PlatformaSDKVersion,
+                renderingMode: this._renderingMode,
+                initialArgs: this._initialArgs,
+                initialUiState: this._initialUiState,
+                inputsValid: this._inputsValid,
+                sections: this._sections,
+                title: this._title,
+                outputs: this._outputs,
+                enrichmentTargets: this._enrichmentTargets,
+                featureFlags: this._featureFlags,
+            },
+            // fields below are added to allow previous desktop versions read generated configs
+            sdkVersion: version.PlatformaSDKVersion,
+            renderingMode: this._renderingMode,
+            initialArgs: this._initialArgs,
+            inputsValid: normalization.downgradeCfgOrLambda(this._inputsValid),
+            sections: normalization.downgradeCfgOrLambda(this._sections),
+            outputs: Object.fromEntries(Object.entries(this._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 };
+        // normal operation inside the UI
+        else
+            return internal.getPlatformaInstance({ sdkVersion: version.PlatformaSDKVersion, apiVersion: platformaApiVersion });
+    }
+}
+
+exports.BlockModel = BlockModel;
+//# sourceMappingURL=builder.cjs.map

package/dist/builder.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.cjs","sources":["../src/builder.ts"],"sourcesContent":["import type { BlockRenderingMode, BlockSection, ValueOrErrors, AnyFunction, PlRef, BlockCodeKnownFeatureFlags, BlockConfigContainer } from '@milaboratories/pl-model-common';\nimport type { Checked, ConfigResult, TypedConfig } from './config';\nimport { getImmediate } from './config';\nimport { getPlatformaInstance, isInUI, tryRegisterCallback } from './internal';\nimport type { Platforma, PlatformaApiVersion, PlatformaV1, PlatformaV2 } from './platforma';\nimport type { InferRenderFunctionReturn, RenderFunction } from './render';\nimport { RenderCtx } from './render';\nimport { PlatformaSDKVersion } from './version';\nimport type {\n  TypedConfigOrConfigLambda,\n  ConfigRenderLambda,\n  StdCtxArgsOnly,\n  DeriveHref,\n  ResolveCfgType,\n  ExtractFunctionHandleReturn,\n  ConfigRenderLambdaFlags,\n} from './bconfig';\nimport {\n  downgradeCfgOrLambda,\n} from './bconfig';\n\ntype SectionsExpectedType = readonly BlockSection[];\n\ntype SectionsCfgChecked<Cfg extends TypedConfig, Args, UiState> = Checked<\n  Cfg,\n  ConfigResult<Cfg, StdCtxArgsOnly<Args, UiState>> extends SectionsExpectedType ? true : false\n>;\n\n// TODO (Unused type in code)\n// type SectionsRFChecked<RF extends Function> = Checked<\n//   RF,\n//   InferRenderFunctionReturn<RF> extends SectionsExpectedType ? true : false\n// >;\n\ntype InputsValidExpectedType = boolean;\n\ntype InputsValidCfgChecked<Cfg extends TypedConfig, Args, UiState> = Checked<\n  Cfg,\n  ConfigResult<Cfg, StdCtxArgsOnly<Args, UiState>> extends InputsValidExpectedType ? true : false\n>;\n\n// TODO (Unused type in code)\n// type InputsValidRFChecked<RF extends Function> = Checked<\n//   RF,\n//   InferRenderFunctionReturn<RF> extends InputsValidExpectedType ? true : false\n// >;\n\ntype NoOb = Record<string, never>;\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. */\nexport class BlockModel<\n  Args,\n  OutputsCfg extends Record<string, TypedConfigOrConfigLambda>,\n  UiState,\n  Href extends `/${string}` = '/',\n> {\n  private constructor(\n    private readonly _renderingMode: BlockRenderingMode,\n    private readonly _initialArgs: Args | undefined,\n    private readonly _initialUiState: UiState,\n    private readonly _outputs: OutputsCfg,\n    private readonly _inputsValid: TypedConfigOrConfigLambda,\n    private readonly _sections: TypedConfigOrConfigLambda,\n    private readonly _title: ConfigRenderLambda | undefined,\n    private readonly _enrichmentTargets: ConfigRenderLambda | undefined,\n    private readonly _featureFlags: BlockCodeKnownFeatureFlags,\n  ) {}\n\n  public static readonly INITIAL_BLOCK_FEATURE_FLAGS: BlockCodeKnownFeatureFlags = {\n    supportsLazyState: true,\n    requiresUIAPIVersion: 1,\n    requiresModelAPIVersion: 1,\n  };\n\n  /** Initiates configuration builder */\n  public static create(renderingMode: BlockRenderingMode): BlockModel<NoOb, {}, NoOb>;\n  /** Initiates configuration builder */\n  public static create(): BlockModel<NoOb, {}, NoOb>;\n  /**\n   * Initiates configuration builder\n   * @deprecated use create method without generic parameter\n   */\n  public static create<Args>(renderingMode: BlockRenderingMode): BlockModel<Args, {}, NoOb>;\n  /**\n   * Initiates configuration builder\n   * @deprecated use create method without generic parameter\n   */\n  public static create<Args>(): BlockModel<Args, {}, NoOb>;\n  public static create(renderingMode: BlockRenderingMode = 'Heavy'): BlockModel<NoOb, {}, NoOb> {\n    return new BlockModel<NoOb, {}, NoOb>(\n      renderingMode,\n      undefined,\n      {},\n      {},\n      getImmediate(true),\n      getImmediate([]),\n      undefined,\n      undefined,\n      { ...BlockModel.INITIAL_BLOCK_FEATURE_FLAGS },\n    );\n  }\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 cfg configuration describing how to render cell value from the blocks\n   *            workflow outputs\n   * @deprecated use lambda-based API\n   * */\n  public output<const Key extends string, const Cfg extends TypedConfig>(\n    key: Key,\n    cfg: Cfg\n  ): BlockModel<Args, OutputsCfg & { [K in Key]: Cfg }, UiState, Href>;\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, UiState>>(\n    key: Key,\n    rf: RF,\n    flags?: ConfigRenderLambdaFlags\n  ): BlockModel<\n    Args,\n    OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> },\n    UiState,\n    Href\n  >;\n  public output(\n    key: string,\n    cfgOrRf: TypedConfig | AnyFunction,\n    flags: ConfigRenderLambdaFlags = {},\n  ): BlockModel<Args, OutputsCfg, UiState, Href> {\n    if (typeof cfgOrRf === 'function') {\n      const handle = `output#${key}`;\n      tryRegisterCallback(handle, () => cfgOrRf(new RenderCtx()));\n      return new BlockModel(\n        this._renderingMode,\n        this._initialArgs,\n        this._initialUiState,\n        {\n          ...this._outputs,\n          [key]: {\n            __renderLambda: true,\n            handle,\n            ...flags,\n          } satisfies ConfigRenderLambda,\n        },\n        this._inputsValid,\n        this._sections,\n        this._title,\n        this._enrichmentTargets,\n        this._featureFlags,\n      );\n    } else\n      return new BlockModel(\n        this._renderingMode,\n        this._initialArgs,\n        this._initialUiState,\n        {\n          ...this._outputs,\n          [key]: cfgOrRf,\n        },\n        this._inputsValid,\n        this._sections,\n        this._title,\n        this._enrichmentTargets,\n        this._featureFlags,\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, UiState>>(\n    key: Key,\n    rf: RF,\n  ): BlockModel<\n      Args,\n    OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> },\n    UiState,\n    Href\n    > {\n    return this.output(key, rf, { retentive: true });\n  }\n\n  /** Sets custom configuration predicate on the block args at which block can be executed\n   * @deprecated use lambda-based API */\n  public argsValid<Cfg extends TypedConfig>(\n    cfg: Cfg & InputsValidCfgChecked<Cfg, Args, UiState>\n  ): BlockModel<Args, OutputsCfg, UiState, Href>;\n  /** Sets custom configuration predicate on the block args at which block can be executed */\n  public argsValid<RF extends RenderFunction<Args, UiState, boolean>>(\n    rf: RF\n  ): BlockModel<Args, OutputsCfg, UiState, Href>;\n  public argsValid(\n    cfgOrRf: TypedConfig | AnyFunction,\n  ): BlockModel<Args, OutputsCfg, UiState, `/${string}`> {\n    if (typeof cfgOrRf === 'function') {\n      tryRegisterCallback('inputsValid', () => cfgOrRf(new RenderCtx()));\n      return new BlockModel<Args, OutputsCfg, UiState>(\n        this._renderingMode,\n        this._initialArgs,\n        this._initialUiState,\n        this._outputs,\n        {\n          __renderLambda: true,\n          handle: 'inputsValid',\n        } satisfies ConfigRenderLambda,\n        this._sections,\n        this._title,\n        this._enrichmentTargets,\n        this._featureFlags,\n      );\n    } else\n      return new BlockModel<Args, OutputsCfg, UiState>(\n        this._renderingMode,\n        this._initialArgs,\n        this._initialUiState,\n        this._outputs,\n        cfgOrRf,\n        this._sections,\n        this._title,\n        this._enrichmentTargets,\n        this._featureFlags,\n      );\n  }\n\n  /** Sets the config to generate list of section in the left block overviews panel\n   * @deprecated use lambda-based API */\n  public sections<const S extends SectionsExpectedType>(\n    rf: S\n  ): BlockModel<Args, OutputsCfg, UiState, DeriveHref<S>>;\n  /** Sets the config to generate list of section in the left block overviews panel */\n  public sections<\n    const Ret extends SectionsExpectedType,\n    const RF extends RenderFunction<Args, UiState, Ret>,\n  >(rf: RF): BlockModel<Args, OutputsCfg, UiState, DeriveHref<ReturnType<RF>>>;\n  public sections<const Cfg extends TypedConfig>(\n    cfg: Cfg & SectionsCfgChecked<Cfg, Args, UiState>\n  ): BlockModel<\n    Args,\n    OutputsCfg,\n    UiState,\n    DeriveHref<ConfigResult<Cfg, StdCtxArgsOnly<Args, UiState>>>\n  >;\n  public sections(\n    arrOrCfgOrRf: SectionsExpectedType | TypedConfig | AnyFunction,\n  ): BlockModel<Args, OutputsCfg, UiState, `/${string}`> {\n    if (Array.isArray(arrOrCfgOrRf)) {\n      return this.sections(getImmediate(arrOrCfgOrRf));\n    } else if (typeof arrOrCfgOrRf === 'function') {\n      tryRegisterCallback('sections', () => arrOrCfgOrRf(new RenderCtx()));\n      return new BlockModel<Args, OutputsCfg, UiState>(\n        this._renderingMode,\n        this._initialArgs,\n        this._initialUiState,\n        this._outputs,\n        this._inputsValid,\n        { __renderLambda: true, handle: 'sections' } as ConfigRenderLambda,\n        this._title,\n        this._enrichmentTargets,\n        this._featureFlags,\n      );\n    } else\n      return new BlockModel<Args, OutputsCfg, UiState>(\n        this._renderingMode,\n        this._initialArgs,\n        this._initialUiState,\n        this._outputs,\n        this._inputsValid,\n        arrOrCfgOrRf as TypedConfig,\n        this._title,\n        this._enrichmentTargets,\n        this._featureFlags,\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, UiState, string>,\n  ): BlockModel<Args, OutputsCfg, UiState, Href> {\n    tryRegisterCallback('title', () => rf(new RenderCtx()));\n    return new BlockModel<Args, OutputsCfg, UiState, Href>(\n      this._renderingMode,\n      this._initialArgs,\n      this._initialUiState,\n      this._outputs,\n      this._inputsValid,\n      this._sections,\n      { __renderLambda: true, handle: 'title' } as ConfigRenderLambda,\n      this._enrichmentTargets,\n      this._featureFlags,\n    );\n  }\n\n  /**\n   * Sets initial args for the block, this value must be specified.\n   * @deprecated use {@link withArgs}\n   * */\n  public initialArgs(value: Args): BlockModel<Args, OutputsCfg, UiState, Href> {\n    return new BlockModel<Args, OutputsCfg, UiState, Href>(\n      this._renderingMode,\n      value,\n      this._initialUiState,\n      this._outputs,\n      this._inputsValid,\n      this._sections,\n      this._title,\n      this._enrichmentTargets,\n      this._featureFlags,\n    );\n  }\n\n  /** Sets initial args for the block, this value must be specified. */\n  public withArgs<Args>(initialValue: Args): BlockModel<Args, OutputsCfg, UiState, Href> {\n    return new BlockModel<Args, OutputsCfg, UiState, Href>(\n      this._renderingMode,\n      initialValue,\n      this._initialUiState,\n      this._outputs,\n      this._inputsValid,\n      this._sections,\n      this._title,\n      this._enrichmentTargets,\n      this._featureFlags,\n    );\n  }\n\n  /** Defines type and sets initial value for block UiState. */\n  public withUiState<UiState>(initialValue: UiState): BlockModel<Args, OutputsCfg, UiState, Href> {\n    return new BlockModel<Args, OutputsCfg, UiState, Href>(\n      this._renderingMode,\n      this._initialArgs,\n      initialValue,\n      this._outputs,\n      this._inputsValid,\n      this._sections,\n      this._title,\n      this._enrichmentTargets,\n      this._featureFlags,\n    );\n  }\n\n  /** Sets or overrides feature flags for the block. */\n  public withFeatureFlags(flags: Partial<BlockCodeKnownFeatureFlags>): BlockModel<Args, OutputsCfg, UiState, Href> {\n    return new BlockModel<Args, OutputsCfg, UiState, Href>(\n      this._renderingMode,\n      this._initialArgs,\n      this._initialUiState,\n      this._outputs,\n      this._inputsValid,\n      this._sections,\n      this._title,\n      this._enrichmentTargets,\n      { ...this._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  ): BlockModel<Args, OutputsCfg, UiState, Href> {\n    tryRegisterCallback('enrichmentTargets', lambda);\n    return new BlockModel<Args, OutputsCfg, UiState, Href>(\n      this._renderingMode,\n      this._initialArgs,\n      this._initialUiState,\n      this._outputs,\n      this._inputsValid,\n      this._sections,\n      this._title,\n      { __renderLambda: true, handle: 'enrichmentTargets' } as ConfigRenderLambda,\n      this._featureFlags,\n    );\n  }\n\n  public done(apiVersion?: 1): PlatformaV1<\n    Args,\n    InferOutputsFromConfigs<Args, OutputsCfg, UiState>,\n    UiState,\n    Href\n  >;\n\n  public done(apiVersion: 2): PlatformaV2<\n    Args,\n    InferOutputsFromConfigs<Args, OutputsCfg, UiState>,\n    UiState,\n    Href\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 state, and\n   * other features provided by the platforma to the block. */\n  public done(apiVersion?: PlatformaApiVersion): Platforma<\n    Args,\n    InferOutputsFromConfigs<Args, OutputsCfg, UiState>,\n    UiState,\n    Href\n  > {\n    const requiresUIAPIVersion = apiVersion ?? 1;\n    return this.withFeatureFlags({\n      ...this._featureFlags,\n      requiresUIAPIVersion,\n    })._done(requiresUIAPIVersion);\n  }\n\n  public _done(apiVersion: PlatformaApiVersion): Platforma<\n    Args,\n    InferOutputsFromConfigs<Args, OutputsCfg, UiState>,\n    UiState,\n    Href\n  > {\n    if (this._initialArgs === undefined) throw new Error('Initial arguments not set.');\n\n    const config: BlockConfigContainer = {\n      v3: {\n        sdkVersion: PlatformaSDKVersion,\n        renderingMode: this._renderingMode,\n        initialArgs: this._initialArgs,\n        initialUiState: this._initialUiState,\n        inputsValid: this._inputsValid,\n        sections: this._sections,\n        title: this._title,\n        outputs: this._outputs,\n        enrichmentTargets: this._enrichmentTargets,\n        featureFlags: this._featureFlags,\n      },\n\n      // fields below are added to allow previous desktop versions read generated configs\n      sdkVersion: PlatformaSDKVersion,\n      renderingMode: this._renderingMode,\n      initialArgs: this._initialArgs,\n      inputsValid: downgradeCfgOrLambda(this._inputsValid),\n      sections: downgradeCfgOrLambda(this._sections),\n      outputs: Object.fromEntries(\n        Object.entries(this._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 } as any;\n    // normal operation inside the UI\n    else return getPlatformaInstance({ sdkVersion: PlatformaSDKVersion, apiVersion: platformaApiVersion }) as any;\n  }\n}\n\nexport type InferOutputType<CfgOrFH, Args, UiState> = CfgOrFH extends TypedConfig\n  ? ResolveCfgType<CfgOrFH, Args, UiState>\n  : CfgOrFH extends ConfigRenderLambda\n    ? ExtractFunctionHandleReturn<CfgOrFH>\n    : never;\n\ntype InferOutputsFromConfigs<\n  Args,\n  OutputsCfg extends Record<string, TypedConfigOrConfigLambda>,\n  UiState,\n> = {\n  [Key in keyof OutputsCfg]: ValueOrErrors<InferOutputType<OutputsCfg[Key], Args, UiState>>;\n};\n"],"names":["getImmediate","tryRegisterCallback","RenderCtx","PlatformaSDKVersion","downgradeCfgOrLambda","isInUI","getPlatformaInstance"],"mappings":";;;;;;;;;;;AAiDA;;AAE0E;MAC7D,UAAU,CAAA;AAOF,IAAA,cAAA;AACA,IAAA,YAAA;AACA,IAAA,eAAA;AACA,IAAA,QAAA;AACA,IAAA,YAAA;AACA,IAAA,SAAA;AACA,IAAA,MAAA;AACA,IAAA,kBAAA;AACA,IAAA,aAAA;AATnB,IAAA,WAAA,CACmB,cAAkC,EAClC,YAA8B,EAC9B,eAAwB,EACxB,QAAoB,EACpB,YAAuC,EACvC,SAAoC,EACpC,MAAsC,EACtC,kBAAkD,EAClD,aAAyC,EAAA;QARzC,IAAA,CAAA,cAAc,GAAd,cAAc;QACd,IAAA,CAAA,YAAY,GAAZ,YAAY;QACZ,IAAA,CAAA,eAAe,GAAf,eAAe;QACf,IAAA,CAAA,QAAQ,GAAR,QAAQ;QACR,IAAA,CAAA,YAAY,GAAZ,YAAY;QACZ,IAAA,CAAA,SAAS,GAAT,SAAS;QACT,IAAA,CAAA,MAAM,GAAN,MAAM;QACN,IAAA,CAAA,kBAAkB,GAAlB,kBAAkB;QAClB,IAAA,CAAA,aAAa,GAAb,aAAa;IAC7B;IAEI,OAAgB,2BAA2B,GAA+B;AAC/E,QAAA,iBAAiB,EAAE,IAAI;AACvB,QAAA,oBAAoB,EAAE,CAAC;AACvB,QAAA,uBAAuB,EAAE,CAAC;KAC3B;AAgBM,IAAA,OAAO,MAAM,CAAC,aAAA,GAAoC,OAAO,EAAA;AAC9D,QAAA,OAAO,IAAI,UAAU,CACnB,aAAa,EACb,SAAS,EACT,EAAE,EACF,EAAE,EACFA,oBAAY,CAAC,IAAI,CAAC,EAClBA,oBAAY,CAAC,EAAE,CAAC,EAChB,SAAS,EACT,SAAS,EACT,EAAE,GAAG,UAAU,CAAC,2BAA2B,EAAE,CAC9C;IACH;AAgCO,IAAA,MAAM,CACX,GAAW,EACX,OAAkC,EAClC,QAAiC,EAAE,EAAA;AAEnC,QAAA,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;AACjC,YAAA,MAAM,MAAM,GAAG,CAAA,OAAA,EAAU,GAAG,EAAE;AAC9B,YAAAC,4BAAmB,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,IAAIC,aAAS,EAAE,CAAC,CAAC;AAC3D,YAAA,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,EACpB;gBACE,GAAG,IAAI,CAAC,QAAQ;gBAChB,CAAC,GAAG,GAAG;AACL,oBAAA,cAAc,EAAE,IAAI;oBACpB,MAAM;AACN,oBAAA,GAAG,KAAK;AACoB,iBAAA;aAC/B,EACD,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,aAAa,CACnB;QACH;;AACE,YAAA,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,EACpB;gBACE,GAAG,IAAI,CAAC,QAAQ;gBAChB,CAAC,GAAG,GAAG,OAAO;aACf,EACD,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,aAAa,CACnB;IACL;;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;AAWO,IAAA,SAAS,CACd,OAAkC,EAAA;AAElC,QAAA,IAAI,OAAO,OAAO,KAAK,UAAU,EAAE;AACjC,YAAAD,4BAAmB,CAAC,aAAa,EAAE,MAAM,OAAO,CAAC,IAAIC,aAAS,EAAE,CAAC,CAAC;AAClE,YAAA,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,QAAQ,EACb;AACE,gBAAA,cAAc,EAAE,IAAI;AACpB,gBAAA,MAAM,EAAE,aAAa;AACO,aAAA,EAC9B,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,aAAa,CACnB;QACH;;AACE,YAAA,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,QAAQ,EACb,OAAO,EACP,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,aAAa,CACnB;IACL;AAoBO,IAAA,QAAQ,CACb,YAA8D,EAAA;AAE9D,QAAA,IAAI,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YAC/B,OAAO,IAAI,CAAC,QAAQ,CAACF,oBAAY,CAAC,YAAY,CAAC,CAAC;QAClD;AAAO,aAAA,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE;AAC7C,YAAAC,4BAAmB,CAAC,UAAU,EAAE,MAAM,YAAY,CAAC,IAAIC,aAAS,EAAE,CAAC,CAAC;YACpE,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,YAAY,EACjB,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAwB,EAClE,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,aAAa,CACnB;QACH;;AACE,YAAA,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,YAAY,EACjB,YAA2B,EAC3B,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,aAAa,CACnB;IACL;;AAGO,IAAA,KAAK,CACV,EAAyC,EAAA;AAEzC,QAAAD,4BAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,IAAIC,aAAS,EAAE,CAAC,CAAC;QACvD,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,SAAS,EACd,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAwB,EAC/D,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,aAAa,CACnB;IACH;AAEA;;;AAGK;AACE,IAAA,WAAW,CAAC,KAAW,EAAA;AAC5B,QAAA,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,KAAK,EACL,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,aAAa,CACnB;IACH;;AAGO,IAAA,QAAQ,CAAO,YAAkB,EAAA;AACtC,QAAA,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,YAAY,EACZ,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,aAAa,CACnB;IACH;;AAGO,IAAA,WAAW,CAAU,YAAqB,EAAA;AAC/C,QAAA,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,YAAY,EACZ,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,aAAa,CACnB;IACH;;AAGO,IAAA,gBAAgB,CAAC,KAA0C,EAAA;QAChE,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,KAAK,EAAE,CACpC;IACH;AAEA;;;AAGG;AACI,IAAA,QAAQ,CACb,MAA+B,EAAA;AAE/B,QAAAD,4BAAmB,CAAC,mBAAmB,EAAE,MAAM,CAAC;QAChD,OAAO,IAAI,UAAU,CACnB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,eAAe,EACpB,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,YAAY,EACjB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,MAAM,EACX,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,mBAAmB,EAAwB,EAC3E,IAAI,CAAC,aAAa,CACnB;IACH;AAgBA;;AAE4D;AACrD,IAAA,IAAI,CAAC,UAAgC,EAAA;AAM1C,QAAA,MAAM,oBAAoB,GAAG,UAAU,IAAI,CAAC;QAC5C,OAAO,IAAI,CAAC,gBAAgB,CAAC;YAC3B,GAAG,IAAI,CAAC,aAAa;YACrB,oBAAoB;AACrB,SAAA,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC;IAChC;AAEO,IAAA,KAAK,CAAC,UAA+B,EAAA;AAM1C,QAAA,IAAI,IAAI,CAAC,YAAY,KAAK,SAAS;AAAE,YAAA,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC;AAElF,QAAA,MAAM,MAAM,GAAyB;AACnC,YAAA,EAAE,EAAE;AACF,gBAAA,UAAU,EAAEE,2BAAmB;gBAC/B,aAAa,EAAE,IAAI,CAAC,cAAc;gBAClC,WAAW,EAAE,IAAI,CAAC,YAAY;gBAC9B,cAAc,EAAE,IAAI,CAAC,eAAe;gBACpC,WAAW,EAAE,IAAI,CAAC,YAAY;gBAC9B,QAAQ,EAAE,IAAI,CAAC,SAAS;gBACxB,KAAK,EAAE,IAAI,CAAC,MAAM;gBAClB,OAAO,EAAE,IAAI,CAAC,QAAQ;gBACtB,iBAAiB,EAAE,IAAI,CAAC,kBAAkB;gBAC1C,YAAY,EAAE,IAAI,CAAC,aAAa;AACjC,aAAA;;AAGD,YAAA,UAAU,EAAEA,2BAAmB;YAC/B,aAAa,EAAE,IAAI,CAAC,cAAc;YAClC,WAAW,EAAE,IAAI,CAAC,YAAY;AAC9B,YAAA,WAAW,EAAEC,kCAAoB,CAAC,IAAI,CAAC,YAAY,CAAC;AACpD,YAAA,QAAQ,EAAEA,kCAAoB,CAAC,IAAI,CAAC,SAAS,CAAC;AAC9C,YAAA,OAAO,EAAE,MAAM,CAAC,WAAW,CACzB,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,EAAEA,kCAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CACxF;SACF;AAED,QAAA,UAAU,CAAC,mBAAmB,GAAG,UAAU;QAE3C,IAAI,CAACC,eAAM,EAAE;;YAEX,OAAO,EAAE,MAAM,EAAS;;;AAErB,YAAA,OAAOC,6BAAoB,CAAC,EAAE,UAAU,EAAEH,2BAAmB,EAAE,UAAU,EAAE,mBAAmB,EAAE,CAAQ;IAC/G;;;;;"}

package/dist/builder.d.ts

@@ -101,4 +101,3 @@ type InferOutputsFromConfigs<Args, OutputsCfg extends Record<string, TypedConfig
     [Key in keyof OutputsCfg]: ValueOrErrors<InferOutputType<OutputsCfg[Key], Args, UiState>>;
 };
 export {};
-//# sourceMappingURL=builder.d.ts.map

package/dist/builder.js

@@ -0,0 +1,164 @@
+import { getImmediate } from './config/actions.js';
+import { tryRegisterCallback, 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 { downgradeCfgOrLambda } from './bconfig/normalization.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. */
+class BlockModel {
+    _renderingMode;
+    _initialArgs;
+    _initialUiState;
+    _outputs;
+    _inputsValid;
+    _sections;
+    _title;
+    _enrichmentTargets;
+    _featureFlags;
+    constructor(_renderingMode, _initialArgs, _initialUiState, _outputs, _inputsValid, _sections, _title, _enrichmentTargets, _featureFlags) {
+        this._renderingMode = _renderingMode;
+        this._initialArgs = _initialArgs;
+        this._initialUiState = _initialUiState;
+        this._outputs = _outputs;
+        this._inputsValid = _inputsValid;
+        this._sections = _sections;
+        this._title = _title;
+        this._enrichmentTargets = _enrichmentTargets;
+        this._featureFlags = _featureFlags;
+    }
+    static INITIAL_BLOCK_FEATURE_FLAGS = {
+        supportsLazyState: true,
+        requiresUIAPIVersion: 1,
+        requiresModelAPIVersion: 1,
+    };
+    static create(renderingMode = 'Heavy') {
+        return new BlockModel(renderingMode, undefined, {}, {}, getImmediate(true), getImmediate([]), undefined, undefined, { ...BlockModel.INITIAL_BLOCK_FEATURE_FLAGS });
+    }
+    output(key, cfgOrRf, flags = {}) {
+        if (typeof cfgOrRf === 'function') {
+            const handle = `output#${key}`;
+            tryRegisterCallback(handle, () => cfgOrRf(new RenderCtx()));
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, {
+                ...this._outputs,
+                [key]: {
+                    __renderLambda: true,
+                    handle,
+                    ...flags,
+                },
+            }, this._inputsValid, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+        }
+        else
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, {
+                ...this._outputs,
+                [key]: cfgOrRf,
+            }, this._inputsValid, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    /** Shortcut for {@link output} with retentive flag set to true. */
+    retentiveOutput(key, rf) {
+        return this.output(key, rf, { retentive: true });
+    }
+    argsValid(cfgOrRf) {
+        if (typeof cfgOrRf === 'function') {
+            tryRegisterCallback('inputsValid', () => cfgOrRf(new RenderCtx()));
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, {
+                __renderLambda: true,
+                handle: 'inputsValid',
+            }, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+        }
+        else
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, cfgOrRf, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    sections(arrOrCfgOrRf) {
+        if (Array.isArray(arrOrCfgOrRf)) {
+            return this.sections(getImmediate(arrOrCfgOrRf));
+        }
+        else if (typeof arrOrCfgOrRf === 'function') {
+            tryRegisterCallback('sections', () => arrOrCfgOrRf(new RenderCtx()));
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, this._inputsValid, { __renderLambda: true, handle: 'sections' }, this._title, this._enrichmentTargets, this._featureFlags);
+        }
+        else
+            return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, this._inputsValid, arrOrCfgOrRf, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    /** Sets a rendering function to derive block title, shown for the block in the left blocks-overview panel. */
+    title(rf) {
+        tryRegisterCallback('title', () => rf(new RenderCtx()));
+        return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, this._inputsValid, this._sections, { __renderLambda: true, handle: 'title' }, this._enrichmentTargets, this._featureFlags);
+    }
+    /**
+     * Sets initial args for the block, this value must be specified.
+     * @deprecated use {@link withArgs}
+     * */
+    initialArgs(value) {
+        return new BlockModel(this._renderingMode, value, this._initialUiState, this._outputs, this._inputsValid, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    /** Sets initial args for the block, this value must be specified. */
+    withArgs(initialValue) {
+        return new BlockModel(this._renderingMode, initialValue, this._initialUiState, this._outputs, this._inputsValid, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    /** Defines type and sets initial value for block UiState. */
+    withUiState(initialValue) {
+        return new BlockModel(this._renderingMode, this._initialArgs, initialValue, this._outputs, this._inputsValid, this._sections, this._title, this._enrichmentTargets, this._featureFlags);
+    }
+    /** Sets or overrides feature flags for the block. */
+    withFeatureFlags(flags) {
+        return new BlockModel(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.
+     */
+    enriches(lambda) {
+        tryRegisterCallback('enrichmentTargets', lambda);
+        return new BlockModel(this._renderingMode, this._initialArgs, this._initialUiState, this._outputs, this._inputsValid, this._sections, this._title, { __renderLambda: true, handle: 'enrichmentTargets' }, this._featureFlags);
+    }
+    /** 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. */
+    done(apiVersion) {
+        const requiresUIAPIVersion = apiVersion ?? 1;
+        return this.withFeatureFlags({
+            ...this._featureFlags,
+            requiresUIAPIVersion,
+        })._done(requiresUIAPIVersion);
+    }
+    _done(apiVersion) {
+        if (this._initialArgs === undefined)
+            throw new Error('Initial arguments not set.');
+        const config = {
+            v3: {
+                sdkVersion: PlatformaSDKVersion,
+                renderingMode: this._renderingMode,
+                initialArgs: this._initialArgs,
+                initialUiState: this._initialUiState,
+                inputsValid: this._inputsValid,
+                sections: this._sections,
+                title: this._title,
+                outputs: this._outputs,
+                enrichmentTargets: this._enrichmentTargets,
+                featureFlags: this._featureFlags,
+            },
+            // fields below are added to allow previous desktop versions read generated configs
+            sdkVersion: PlatformaSDKVersion,
+            renderingMode: this._renderingMode,
+            initialArgs: this._initialArgs,
+            inputsValid: downgradeCfgOrLambda(this._inputsValid),
+            sections: downgradeCfgOrLambda(this._sections),
+            outputs: Object.fromEntries(Object.entries(this._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 };
+        // normal operation inside the UI
+        else
+            return getPlatformaInstance({ sdkVersion: PlatformaSDKVersion, apiVersion: platformaApiVersion });
+    }
+}
+
+export { BlockModel };
+//# sourceMappingURL=builder.js.map