@platforma-sdk/model 1.58.5 → 1.58.11

package/dist/block_model_legacy.d.ts

@@ -1,9 +1,16 @@
-import type { BlockRenderingMode, BlockSection, PlRef, BlockCodeKnownFeatureFlags } from "@milaboratories/pl-model-common";
-import type { Checked, ConfigResult, TypedConfig } from "./config";
-import type { PlatformaV1, PlatformaV2 } from "./platforma";
-import type { InferRenderFunctionReturn, RenderFunctionLegacy } from "./render";
-import type { TypedConfigOrConfigLambda, ConfigRenderLambda, StdCtxArgsOnly, DeriveHref, ConfigRenderLambdaFlags, InferOutputsFromConfigs } from "./bconfig";
-import type { PlatformaExtended } from "./platforma";
+import { ConfigResult, TypedConfig } from "./config/type_engine.js";
+import { Checked } from "./config/type_util.js";
+import "./config/index.js";
+import { TypedConfigOrConfigLambda } from "./bconfig/types.js";
+import { ConfigRenderLambda, ConfigRenderLambdaFlags, InferOutputsFromConfigs, StdCtxArgsOnly } from "./bconfig/lambdas.js";
+import { DeriveHref } from "./bconfig/util.js";
+import "./bconfig/index.js";
+import { InferRenderFunctionReturn, RenderFunctionLegacy } from "./render/api.js";
+import "./render/index.js";
+import { PlatformaExtended, PlatformaV1, PlatformaV2 } from "./platforma.js";
+import { BlockCodeKnownFeatureFlags, BlockRenderingMode, BlockSection, PlRef } from "@milaboratories/pl-model-common";
+
+//#region src/block_model_legacy.d.ts
 type SectionsExpectedType = readonly BlockSection[];
 type SectionsCfgChecked<Cfg extends TypedConfig, Args, UiState> = Checked<Cfg, ConfigResult<Cfg, StdCtxArgsOnly<Args, UiState>> extends SectionsExpectedType ? true : false>;
 type InputsValidExpectedType = boolean;
@@ -12,105 +19,100 @@ type NoOb = Record<string, never>;
 /** 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. */
-export declare class BlockModel<Args, OutputsCfg extends Record<string, TypedConfigOrConfigLambda>, UiState, Href extends `/${string}` = "/"> {
-    #private;
-    private config;
-    private constructor();
-    static get INITIAL_BLOCK_FEATURE_FLAGS(): BlockCodeKnownFeatureFlags;
-    /** Initiates configuration builder */
-    static create(renderingMode: BlockRenderingMode): BlockModel<NoOb, {}, NoOb>;
-    /** Initiates configuration builder */
-    static create(): BlockModel<NoOb, {}, NoOb>;
-    /**
-     * Initiates configuration builder
-     * @deprecated use create method without generic parameter
-     */
-    static create<Args>(renderingMode: BlockRenderingMode): BlockModel<Args, {}, NoOb>;
-    /**
-     * Initiates configuration builder
-     * @deprecated use create method without generic parameter
-     */
-    static create<Args>(): BlockModel<Args, {}, NoOb>;
-    /**
-     * Add output cell to the configuration
-     *
-     * @param key output cell name, that can be later used to retrieve the rendered value
-     * @param cfg configuration describing how to render cell value from the blocks
-     *            workflow outputs
-     * @deprecated use lambda-based API
-     * */
-    output<const Key extends string, const Cfg extends TypedConfig>(key: Key, cfg: Cfg): BlockModel<Args, OutputsCfg & {
-        [K in Key]: Cfg;
-    }, UiState, Href>;
-    /**
-     * 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 RenderFunctionLegacy<Args, UiState>>(key: Key, rf: RF, flags: ConfigRenderLambdaFlags & {
-        withStatus: true;
-    }): BlockModel<Args, OutputsCfg & {
-        [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> & {
-            withStatus: true;
-        };
-    }, UiState, 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 RenderFunctionLegacy<Args, UiState>>(key: Key, rf: RF, flags?: ConfigRenderLambdaFlags): BlockModel<Args, OutputsCfg & {
-        [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>>;
-    }, UiState, Href>;
-    /** Shortcut for {@link output} with retentive flag set to true. */
-    retentiveOutput<const Key extends string, const RF extends RenderFunctionLegacy<Args, UiState>>(key: Key, rf: RF): BlockModel<Args, OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>>; }, UiState, Href>;
-    /** Shortcut for {@link output} with withStatus flag set to true. */
-    outputWithStatus<const Key extends string, const RF extends RenderFunctionLegacy<Args, UiState>>(key: Key, rf: RF): BlockModel<Args, OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> & {
-        withStatus: true;
-    }; }, UiState, Href>;
-    /** Shortcut for {@link output} with retentive and withStatus flags set to true. */
-    retentiveOutputWithStatus<const Key extends string, const RF extends RenderFunctionLegacy<Args, UiState>>(key: Key, rf: RF): BlockModel<Args, OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> & {
-        withStatus: true;
-    }; }, UiState, Href>;
-    /** Sets custom configuration predicate on the block args at which block can be executed
-     * @deprecated use lambda-based API */
-    argsValid<Cfg extends TypedConfig>(cfg: Cfg & InputsValidCfgChecked<Cfg, Args, UiState>): BlockModel<Args, OutputsCfg, UiState, Href>;
-    /** Sets custom configuration predicate on the block args at which block can be executed */
-    argsValid<RF extends RenderFunctionLegacy<Args, UiState, boolean>>(rf: RF): BlockModel<Args, OutputsCfg, UiState, Href>;
-    /** Sets the config to generate list of section in the left block overviews panel
-     * @deprecated use lambda-based API */
-    sections<const S extends SectionsExpectedType>(rf: S): BlockModel<Args, OutputsCfg, UiState, DeriveHref<S>>;
-    /** Sets the config to generate list of section in the left block overviews panel */
-    sections<const Ret extends SectionsExpectedType, const RF extends RenderFunctionLegacy<Args, UiState, Ret>>(rf: RF): BlockModel<Args, OutputsCfg, UiState, DeriveHref<ReturnType<RF>>>;
-    sections<const Cfg extends TypedConfig>(cfg: Cfg & SectionsCfgChecked<Cfg, Args, UiState>): BlockModel<Args, OutputsCfg, UiState, DeriveHref<ConfigResult<Cfg, StdCtxArgsOnly<Args, UiState>>>>;
-    /** Sets a rendering function to derive block title, shown for the block in the left blocks-overview panel. */
-    title(rf: RenderFunctionLegacy<Args, UiState, string>): BlockModel<Args, OutputsCfg, UiState, Href>;
-    subtitle(rf: RenderFunctionLegacy<Args, UiState, string>): BlockModel<Args, OutputsCfg, UiState, Href>;
-    tags(rf: RenderFunctionLegacy<Args, UiState, string[]>): BlockModel<Args, OutputsCfg, UiState, Href>;
-    /**
-     * Sets initial args for the block, this value must be specified.
-     * @deprecated use {@link withArgs}
-     * */
-    initialArgs(value: Args): BlockModel<Args, OutputsCfg, UiState, Href>;
-    /** Sets initial args for the block, this value must be specified. */
-    withArgs<Args>(initialArgs: Args): BlockModel<Args, OutputsCfg, UiState, Href>;
-    /** Defines type and sets initial value for block UiState. */
-    withUiState<UiState>(initialUiState: UiState): BlockModel<Args, OutputsCfg, UiState, Href>;
-    /** Sets or overrides feature flags for the block. */
-    withFeatureFlags(flags: Partial<BlockCodeKnownFeatureFlags>): BlockModel<Args, OutputsCfg, UiState, 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[]): BlockModel<Args, OutputsCfg, UiState, Href>;
-    done(apiVersion?: 1): PlatformaExtended<PlatformaV1<Args, InferOutputsFromConfigs<Args, OutputsCfg, UiState>, UiState, Href>>;
-    done(apiVersion: 2): PlatformaExtended<PlatformaV2<Args, InferOutputsFromConfigs<Args, OutputsCfg, UiState>, UiState, Href>>;
+declare class BlockModel<Args, OutputsCfg extends Record<string, TypedConfigOrConfigLambda>, UiState, Href extends `/${string}` = "/"> {
+  #private;
+  private config;
+  private constructor();
+  static get INITIAL_BLOCK_FEATURE_FLAGS(): BlockCodeKnownFeatureFlags;
+  /** Initiates configuration builder */
+  static create(renderingMode: BlockRenderingMode): BlockModel<NoOb, {}, NoOb>;
+  /** Initiates configuration builder */
+  static create(): BlockModel<NoOb, {}, NoOb>;
+  /**
+   * Initiates configuration builder
+   * @deprecated use create method without generic parameter
+   */
+  static create<Args>(renderingMode: BlockRenderingMode): BlockModel<Args, {}, NoOb>;
+  /**
+   * Initiates configuration builder
+   * @deprecated use create method without generic parameter
+   */
+  static create<Args>(): BlockModel<Args, {}, NoOb>;
+  /**
+   * Add output cell to the configuration
+   *
+   * @param key output cell name, that can be later used to retrieve the rendered value
+   * @param cfg configuration describing how to render cell value from the blocks
+   *            workflow outputs
+   * @deprecated use lambda-based API
+   * */
+  output<const Key extends string, const Cfg extends TypedConfig>(key: Key, cfg: Cfg): BlockModel<Args, OutputsCfg & { [K in Key]: Cfg }, UiState, Href>;
+  /**
+   * 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 RenderFunctionLegacy<Args, UiState>>(key: Key, rf: RF, flags: ConfigRenderLambdaFlags & {
+    withStatus: true;
+  }): BlockModel<Args, OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> & {
+    withStatus: true;
+  } }, UiState, 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 RenderFunctionLegacy<Args, UiState>>(key: Key, rf: RF, flags?: ConfigRenderLambdaFlags): BlockModel<Args, OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> }, UiState, Href>;
+  /** Shortcut for {@link output} with retentive flag set to true. */
+  retentiveOutput<const Key extends string, const RF extends RenderFunctionLegacy<Args, UiState>>(key: Key, rf: RF): BlockModel<Args, OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> }, UiState, Href>;
+  /** Shortcut for {@link output} with withStatus flag set to true. */
+  outputWithStatus<const Key extends string, const RF extends RenderFunctionLegacy<Args, UiState>>(key: Key, rf: RF): BlockModel<Args, OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> & {
+    withStatus: true;
+  } }, UiState, Href>;
+  /** Shortcut for {@link output} with retentive and withStatus flags set to true. */
+  retentiveOutputWithStatus<const Key extends string, const RF extends RenderFunctionLegacy<Args, UiState>>(key: Key, rf: RF): BlockModel<Args, OutputsCfg & { [K in Key]: ConfigRenderLambda<InferRenderFunctionReturn<RF>> & {
+    withStatus: true;
+  } }, UiState, Href>;
+  /** Sets custom configuration predicate on the block args at which block can be executed
+   * @deprecated use lambda-based API */
+  argsValid<Cfg extends TypedConfig>(cfg: Cfg & InputsValidCfgChecked<Cfg, Args, UiState>): BlockModel<Args, OutputsCfg, UiState, Href>;
+  /** Sets custom configuration predicate on the block args at which block can be executed */
+  argsValid<RF extends RenderFunctionLegacy<Args, UiState, boolean>>(rf: RF): BlockModel<Args, OutputsCfg, UiState, Href>;
+  /** Sets the config to generate list of section in the left block overviews panel
+   * @deprecated use lambda-based API */
+  sections<const S extends SectionsExpectedType>(rf: S): BlockModel<Args, OutputsCfg, UiState, DeriveHref<S>>;
+  /** Sets the config to generate list of section in the left block overviews panel */
+  sections<const Ret extends SectionsExpectedType, const RF extends RenderFunctionLegacy<Args, UiState, Ret>>(rf: RF): BlockModel<Args, OutputsCfg, UiState, DeriveHref<ReturnType<RF>>>;
+  sections<const Cfg extends TypedConfig>(cfg: Cfg & SectionsCfgChecked<Cfg, Args, UiState>): BlockModel<Args, OutputsCfg, UiState, DeriveHref<ConfigResult<Cfg, StdCtxArgsOnly<Args, UiState>>>>;
+  /** Sets a rendering function to derive block title, shown for the block in the left blocks-overview panel. */
+  title(rf: RenderFunctionLegacy<Args, UiState, string>): BlockModel<Args, OutputsCfg, UiState, Href>;
+  subtitle(rf: RenderFunctionLegacy<Args, UiState, string>): BlockModel<Args, OutputsCfg, UiState, Href>;
+  tags(rf: RenderFunctionLegacy<Args, UiState, string[]>): BlockModel<Args, OutputsCfg, UiState, Href>;
+  /**
+   * Sets initial args for the block, this value must be specified.
+   * @deprecated use {@link withArgs}
+   * */
+  initialArgs(value: Args): BlockModel<Args, OutputsCfg, UiState, Href>;
+  /** Sets initial args for the block, this value must be specified. */
+  withArgs<Args>(initialArgs: Args): BlockModel<Args, OutputsCfg, UiState, Href>;
+  /** Defines type and sets initial value for block UiState. */
+  withUiState<UiState>(initialUiState: UiState): BlockModel<Args, OutputsCfg, UiState, Href>;
+  /** Sets or overrides feature flags for the block. */
+  withFeatureFlags(flags: Partial<BlockCodeKnownFeatureFlags>): BlockModel<Args, OutputsCfg, UiState, 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[]): BlockModel<Args, OutputsCfg, UiState, Href>;
+  done(apiVersion?: 1): PlatformaExtended<PlatformaV1<Args, InferOutputsFromConfigs<Args, OutputsCfg, UiState>, UiState, Href>>;
+  done(apiVersion: 2): PlatformaExtended<PlatformaV2<Args, InferOutputsFromConfigs<Args, OutputsCfg, UiState>, UiState, Href>>;
 }
-export {};
+//#endregion
+export { BlockModel };
 //# sourceMappingURL=block_model_legacy.d.ts.map